MstrInquire

Inquires either the maximum (total) number of all strings that can be read with a String Reader context (M_CONTEXT), or the maximum number of a specific string (M_STRING_INDEX()) that can be read with a String Reader context. SET

Inquires the character value for each character. Unless a data type from the table For specifying the data type is explicitly added to M_CHAR_VALUE, the string array must be of the right type for the encoding scheme selected (MstrInquire() with M_ENCODING).

Inquires the number of characters in the font-based or fontless context.

Inquires the width of the space character of the font or fontless context. SET

Inquires the actual width value of the space character of the font or fontless context.

Inquires the status of each character in the context, where the status determines whether the String Reader module should search for the character in the image.

Note that this inquire type is only available for a fontless context. SET SET

Inquires the type of String Reader context.

Inquires the width of the image buffer needed by the last call to MstrDraw(). This allows you to allocate a buffer of optimal size, for the required drawing operation.

Note that when you call MstrDraw() for the first time, you can pass M_NULL as the destination image to get the size needed for the required drawing operation. For more information, see MstrDraw().

Inquires the height of the image buffer needed by the last call to MstrDraw(). This allows you to allocate a buffer of optimal size, for the required drawing operation.

Note that when you call MstrDraw() for the first time, you can pass M_NULL as the destination image to get the size needed for the required drawing operation. For more information, see MstrDraw().

Inquires the type of character encoding used by the String Reader context. SET

Inquires the width (X-size) of the widest, enabled character in the fontless context when it has a height of M_REF_CHAR_SIZE_Y.

Note that this inquire type is only available for a fontless context. SET

Inquires the width (X-size) of the narrowest, enabled character in the fontless context when it has a height of M_REF_CHAR_SIZE_Y.

Note that this inquire type is only available for a fontless context. SET

Inquires the minimum contrast between a character in the target image and its background, in order for the character to be read by MstrRead(). SET

Inquires the current value of the modification counter. The modification counter is increased by one each time settings for the context are modified.

Although you cannot identify the modification counter's contents, you can compare them throughout your application to know if the context has been altered. If the modification counter has changed you can, for example, prompt the user to save before closing the application.

Inquires the number of fonts in the context.

Note that this inquire type is only available for a font-based context.

Inquires the number of string models in the context.

Inquires whether the String Reader context is preprocessed. This will indicate whether preprocessing (using MstrPreprocess()) is needed to prepare the context for use.

Inquires the reference height.

Note that this inquire type is only available for a fontless context. SET

Inquires the stroke width of characters in the fontless context when they have a height of M_REF_CHAR_SIZE_Y.

Note that this inquire type is only available for a fontless context. SET

Inquires whether strategies specific to angular-range will be calculated. SET

Inquires whether strategies specific to angular-range skew will be calculated. SET

Inquires whether to search for the string angle. SET

Inquires the character value to use as a space character within the formatted text that will be read. SET

Inquires the search/read speed. SET

Inquires the character value to use as a string separator within the formatted text that will be read. SET

Inquires the number of character thickening iterations. SET

Inquires the threshold method of the character blob extraction. SET

Inquires the global threshold value when M_THRESHOLD_MODE is set to M_USER_DEFINED (otherwise it is ignored). SET

Inquires the maximum read time for MstrRead(), in msec. SET

Inquires the acceptance level for the character score. SET

Inquires the factor used to determine the upper limit of the aspect ratio for the characters in the string.

Note that this inquire type is only available for a font-based context. SET

Inquires the factor used to determine the lower limit of the aspect ratio for the characters in the string.

Note that this inquire type is only available for a font-based context. SET

Inquires the acceptance level for the character's homogeneity score. SET

Inquires the maximum deviation that a character can have from the string's baseline. SET

Inquires the factor used to determine the upper limit (maximum permitted scale) of the scale range for the characters in the string. SET

Inquires the factor used to determine the lower limit (minimum permitted scale) of the scale range for the characters in the string. SET

Inquires the acceptance level for the character's similarity score. SET

Inquires the font index for each default font constraint.

The default constraint is applied, by default, either for all positions of the string model, if no explicit constraint has been set, or for a specific position, if M_DEFAULT has been set for a specific position.

This information can also be inquired using MstrInquire() with M_DEFAULT_CONSTRAINT_TYPE; however, it is encoded with other constant values.

M_DEFAULT_CONSTRAINT_FONT always returns a single value.

Note that this inquire type is only available for a font-based context. SET

Inquires the default constraint type.

The default constraint is applied, by default, either for all positions of the string model, if no explicit constraint has been set, or for a specific position, if M_DEFAULT has been set for a specific position.

M_DEFAULT_CONSTRAINT_TYPE always returns a single value.

Inquires the foreground color of the string. SET

Inquires the number of positions in the string that have a non-default constraint. Non-default constraints are constraints that have been set to a value other than M_DEFAULT.

Constraints are added to a string using MstrSetConstraint().

Inquires the maximum number of consecutive space characters allowed in the string. SET

Inquires the acceptance level for the string score. SET

Inquires the nominal angle of the string. SET

Inquires the lower limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET

Inquires the upper limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET

Inquires the nominal aspect ratio of the string.

Note that this inquire type is only available for a font-based context. SET

Inquires the factor used to determine the upper limit of the string's aspect ratio. This value is relative to the nominal aspect ratio (MstrControl() with M_STRING_ASPECT_RATIO).

Note that this inquire type is only available for a font-based context. SET

Inquires the factor used to determine the lower limit of the string's aspect ratio. This value is relative to the nominal aspect ratio (MstrControl() with M_STRING_ASPECT_RATIO).

Note that this inquire type is only available for a font-based context. SET

Inquires the certainty level for the string score. SET

Inquires the nominal scale of the string. SET

Inquires the factor used to determine the upper limit (maximum permitted scale) of the string's scale range. This value is relative to the nominal scale (MstrControl() with M_STRING_SCALE). SET

Inquires the factor used to determine the lower limit (minimum permitted scale) of the string's scale range. This value is relative to the nominal scale (MstrControl() with M_STRING_SCALE). SET

Inquires the maximum string size (number of characters) of the string model. SET

Inquires the minimum string size (number of characters) of the string model. SET

Inquires the acceptance level for the string target score. SET

Inquires the certainty level for the string target score. SET

Inquires the type of the string model added to the String Reader context. SET

Inquires the string model's user-defined label. SET

Inquires the constraint string at the specified index.

Unless a data type from the table For specifying the data type is explicitly added to M_CONSTRAINT, the string array type corresponds to the encoding scheme selected with M_ENCODING. The string returned is null-terminated. SET

Inquires the allocation size needed for each non-default constraint string. The allocation size of the constraint string includes the terminating null character ("\0").

Inquires the font index for each non-default constraint of the string model. This information can also be inquired using MstrInquire() with M_CONSTRAINT_TYPE; however, it is encoded with other constant values.

You can inquire the position in the string model to which the constraint applies using MstrInquire() with M_CONSTRAINT_POSITION.

Note that this inquire type is only available for a font-based context. SET

Inquires the position of each non-default constraint in the string model (0, 255). The default constraint is therefore applied to all positions not returned in this array.

Inquires the type of each non-default constraint of the string model (for example, M_LETTER, M_DIGIT). You can inquire the position in the string model to which this constraint applies using MstrInquire() with M_CONSTRAINT_POSITION. SET

Inquires the default constraint string.

The default constraint is applied, by default, either for all positions of the string model, if no explicit constraint has been set, or for a specific position, if M_DEFAULT has been set for a specific position.

The string array must be large enough to contain M_DEFAULT_CONSTRAINT + M_STRING_SIZE characters.

Unless a data type from the table For specifying the data type is explicitly added to M_DEFAULT_CONSTRAINT, the string array type corresponds to the encoding scheme selected with M_ENCODING. The string returned is null-terminated.

Inquires the setting for the baseline value for each character. To return the automatically calculated character baseline (when M_CHAR_BASELINE is set to M_AUTO_COMPUTE), use M_CHAR_BASELINE_VALUE.

Note that this inquire type is only available for a font-based context. SET

Inquires the baseline value for each character. Note that when M_CHAR_BASELINE is set to M_AUTO_COMPUTE, this value will return the calculated character baseline.

Note that this inquire type is only available for a font-based context. SET

Inquires the X-size of each character in the font. SET SET

Inquires the Y-size of each character in the font. SET SET

Inquires the average thickness of each character in the font. SET

Inquires the type of each character in the font. SET

Inquires the type value of each character in the font. When the value of M_CHAR_TYPE is M_AUTO_COMPUTE, M_CHAR_TYPE_VALUE contains the auto-computed value (M_REGULAR or M_PUNCTUATION). For more information, see MstrEditFont() with M_CHAR_TYPE.

Inquires the X-offset for each character in the font. The X- and Y-offsets define where the character is found in the definition image. This inquire type is only valid for user-defined characters (MstrEditFont() with M_USER_DEFINED).

Inquires the Y-offset for each character in the font. The X- and Y-offsets define where the character is found in the definition image. This inquire type is only valid for user-defined characters (MstrEditFont() with M_USER_DEFINED).

Inquires the margin in the X-direction, between the character box and the drawing box. SET

Inquires the margin in the Y-direction, between the character box and the drawing box. SET

Inquires the type of font added. SET

Inquires the font's user-defined label. SET

Inquires whether results are returned in pixel or world units. SET

Inquires the identifier of the system on which the String Reader context or result buffer was allocated. SET SET