MstrGetResult

Retrieves the total number of characters read (all strings together).

Retrieves the identifier of the String Reader context used by MstrRead() to obtain the results in the result buffer. Note that this identifier might not be valid if the String Reader context has been freed using MstrFree().

Retrieves the total number of strings read.

Retrieves the entire text. This includes all string characters, the inserted space characters, the string separators, and the terminating null character ("\0").

Strings are ordered in the natural Latin-based reading order.

A space character is inserted in the text each time the distance between two adjacent characters exceeds the space width, at the scale of the string. The inserted space character can be set using MstrControl() with M_SPACE_CHARACTER. By default, the inserted space character is a space (ASCII code 32).

A string separator is inserted between each string in the text; that is, each time the distance between two adjacent characters is greater than the space size, which depends on the space width (at the scale of the string) and the maximum number of consecutive spaces. The string separator can be set using MstrControl() with M_STRING_SEPARATOR. By default, the string separator is a new line (ASCII code 10).

Retrieves the number of bytes required to retrieve M_TEXT result(s). This includes all string characters, the inserted space characters, the string separators, the terminating null character ("\0"), and takes the encoding bit size into account (MstrControl() with M_ENCODING). Note that the size returned is always the number of bytes, not the number of characters.

Retrieves the total number of characters in the text. This includes all strings characters, the inserted space characters, and the string separators. Note that this does not include the terminating null character ("\0"). The string separator can be controlled using MstrControl() with M_STRING_SEPARATOR. The inserted space characters can be controlled using MstrControl() with M_SPACE_CHARACTER.

Retrieves whether the timeout limit was reached. You can set the timeout limit using MstrControl() with M_TIMEOUT.

Retrieves the angle of the characters in the string, in degrees. The angle is the same for all the characters in the string; different angles for individual characters within a string cannot be obtained. The characters' angle is not necessarily equal to the string's angle.

The angle is measured counter-clockwise, from the positive X-axis towards the negative Y-axis of the image.

Retrieves the foreground value of the string read.

Retrieves the formatted string. This includes all strings characters, the inserted space characters and the terminating null character ("\0").

A space character is inserted in the formatted string each time the distance between two adjacent characters exceeds the space width, at the scale of the string. The inserted space character can be set using MstrControl() with M_SPACE_CHARACTER. By default, the inserted space character is a space (ASCII code 32).

Retrieves the number of characters in the formatted string. This includes string characters and the inserted space characters. This does not include the terminating null character ("\0").

A space character is inserted in the formatted string each time the distance between 2 adjacent characters exceeds the M_SPACE_WIDTH value, which you can set with MstrControl(). Note that the inserted space characters can be controlled using MstrControl() with M_SPACE_CHARACTER.

Retrieves the angle of the characters' skew in the string, in degrees. The angle is the same for all the characters in the string; different angles for individual characters within a string cannot be obtained.

Retrieves the terminating null character ("\0") that was located during the read operation. The string does not contain any space characters or string separators.

Refer to M_CHAR_VALUE to retrieve all characters of all strings without the terminating null character ("\0"). Refer to M_FORMATTED_STRING or M_TEXT to retrieve all strings with their space characters and/or string separators.

Retrieves the number of bytes required to retrieve M_STRING result(s). This includes the terminating null character ("\0"), and takes the encoding bit size into account (MstrControl() with M_ENCODING). M_STRING_ALLOC_SIZE_BYTE is typically used when retrieving all results (M_ALL), and will return an array of string size byte (1 element for each string). Note that the size is always the number of bytes, not the number of characters.

Retrieves the angle of the string, in degrees.

An angle interpreted with respect to the pixel coordinate system is always measured counter-clockwise, from the positive X-axis towards the negative Y-axis of the image. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 25: Calibrating your camera setup.

Retrieves the aspect ratio of the string. The aspect ratio of the string is the median aspect ratio of all the characters in the string.

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

Retrieves the X-position of the bottom-left corner of the bounding box of the string.

Retrieves the Y-position of the bottom-left corner of the bounding box of the string.

Retrieves the X-position of the bottom-right corner of the bounding box of the string.

Retrieves the Y-position of the bottom-right corner of the bounding box of the string.

Retrieves the X-position of the top-left corner of the bounding box of the string.

Retrieves the Y-position of the top-left corner of the bounding box of the string.

Retrieves the X-position of the top-right corner of the bounding box of the string.

Retrieves the Y-position of the top-right corner of the bounding box of the string.

Retrieves the maximum character score of the string.

Retrieves the minimum character score of the string.

Retrieves the index of the string model read.

Retrieves the user label of the string model read.

Retrieves the X-position of the string. The position of the string is the position of its first character. For more information, see M_CHAR_POSITION_X.

Retrieves the Y-position of the string. The position of the string is the position of its first character. For more information, see M_CHAR_POSITION_Y.

Retrieves the scale of the string. The scale of the string is the median scale in the X-direction of all the characters in the string.

Retrieves the string score calculated during the read operation for the entire string. The string score is the average score of the characters in the string.

Retrieves the size of the string. This does not include the terminating null character ("\0"). Space characters are not counted in the string size.

Retrieves the string target score calculated during the read operation for the entire string.

The string target score is computed from the unread characters that are in the region of the string in the target image. These otherwise readable characters remain unread due to user-specified constraints, such as scale and grammar restrictions. The more unread characters there are, the lower the target score will be.

Retrieves the aspect ratio of the character. The aspect ratio of the character is the ratio of its scale in the X-direction and in the Y-direction.

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

Retrieves the baseline deviation of every read character within the string. This represents the deviation of the character's baseline from the string's baseline. For non-punctuation characters, this value is a percentage of the character's height (Y-size). For punctuation characters, this value is a percentage of the height of the tallest character within the font. For more information, refer to MstrControl() with M_CHAR_MAX_BASELINE_DEVIATION and the Character's maximum baseline deviation subsection of the Degrees of freedom section of Chapter 11: String Reader.

Note that if the character's baseline is set to M_NONE, its deviation will always be returned as '0'.

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

Retrieves the X-position of the bottom-left corner of the bounding box of each character.

Retrieves the Y-position of the bottom-left corner of the bounding box of each character.

Retrieves the X-position of the bottom-right corner of the bounding box of each character.

Retrieves the Y-position of the bottom-right corner of the bounding box of each character.

Retrieves the X-position of the top-left corner of the bounding box of each character.

Retrieves the Y-position of the top-left corner of the bounding box of each character.

Retrieves the X-position of the top-right corner of the bounding box of each character.

Retrieves the Y-position of the top-right corner of the bounding box of each character.

Retrieves the number of consecutive spaces that can be inserted between this character and the following one in the string. For more information, refer to M_SPACE_WIDTH and M_SPACE_MAX_CONSECUTIVE in MstrControl().

Retrieves the index of the font of each individual character within the string(s). The index returned is that of the character's font at the moment the MstrRead() operation was performed.

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

Retrieves the user label of the font of each individual character within the string(s).

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

Retrieves the homogeneity score of each individual character within the string(s). The character's homogeneity score quantifies the similarity between the character in the target and the other characters of the string in the target.

Retrieves the index of the character in the font for each individual character within the string(s). The index returned is that of the index of the character in its font at the moment the MstrRead() operation was performed.

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

Retrieves the X-position of the character. The position of a character is the position of its center of gravity.

Retrieves the Y-position of the character. The position of a character is the position of its center of gravity.

Retrieves the scale of the character. The scale of the character is its scale in the X-direction.

Retrieves the score of each individual character within the string(s). The character's score quantifies the similarity between the character in the target and the character in the font; it also quantifies the similarity between the character in the target and the other characters of the string in the target.

Retrieves the similarity score of each individual character within the string(s). The character's similarity score quantifies the similarity between the character in the target and the character in the font.

Retrieves the value of each character read.

Retrieves the forward transformation coefficient A.

Retrieves the reverse transformation coefficient A.

Retrieves the forward transformation coefficient B.

Retrieves the reverse transformation coefficient B.

Retrieves the forward transformation coefficient C.

Retrieves the reverse transformation coefficient C.

Retrieves the forward transformation coefficient D.

Retrieves the reverse transformation coefficient D.

Retrieves the forward transformation coefficient E.

Retrieves the reverse transformation coefficient E.

Retrieves the forward transformation coefficient F.

Retrieves the reverse transformation coefficient F.

Retrieves a list of all the errors reported by the last call to MstrExpert().

To inquire the string associated with an error, use MstrInquire() with M_REPORT_STRING.

Retrieves the number of errors reported by the last call to MstrExpert().

Retrieves the number of warnings reported by the last call to MstrExpert().

Retrieves a list of all the warnings reported by the last call to MstrExpert().

To inquire the string associated with a warning, use MstrInquire() with M_REPORT_STRING.