Filters
Filter values by
  • General results
  • String results
  • Character results
  • Transformation coefficient results
  • Error results
| Customize Help
| Save Settings

MstrGetResult



Function Map
Synopsis
Get the specified type of result(s) from a String Reader result buffer.
Syntax
void MstrGetResult(
MIL_ID ResultId, //in
MIL_INT Index, //in
MIL_INT64 ResultType, //in
void *ResultArrayPtr //out
)
Description

This function retrieves the result(s) of the specified type from a String Reader result buffer. Results are only available after calling MstrRead().

When retrieving results, you will need to know the required type and size of the array in which to store the results. Typically, the default data type is MIL_DOUBLE. For certain results (such as, M_TEXT, M_FORMATTED_STRING, and M_STRING), the default type of the required array depends on the selected encoding scheme (MstrControl() with M_ENCODING). You can specify any data type by explicitly adding it to the result. The size of the array depends on the result type.

Unless otherwise specified, the value settings are applicable to both font based and fontless contexts.

If your target image (MstrRead()) was associated with a camera calibration context, positional and dimensional results are, by default, returned with respect to the relative coordinate system of the image. Otherwise, these results are returned in pixels, relative to the center of top-left pixel in the target image.

If your target image was associated with a camera calibration context but you want to retrieve positional and dimensional results in pixel units, use MstrControl() with the M_RESULT_OUTPUT_UNITS control type set to M_PIXEL. However, if you set M_RESULT_OUTPUT_UNITS to M_WORLD without specifying a calibrated image in which to calculate the results, MstrGetResult() generates an error.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ResultId

Specifies the identifier of the String Reader result buffer from which to retrieve results.

Index

Specifies where to get results. This parameter can be set to one of the following:

function map For specifying where to get results
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_ALL.

Click to summarize M_ALL

Specifies that the results of all strings will be retrieved.

Click to summarize M_GENERAL

Specifies that the results relating to the entire String Reader context will be retrieved.

Click to summarize 0 <= Value < M_STRING_NUMBER

Specifies the index of the string from which to get results.

ResultType

Specifies the type of result to retrieve.

See the Parameter associations section for possible values that can be specified.

ResultArrayPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • array of type char [optionally, in C++: a reference to a std::vector<char> ]
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT16 [optionally, in C++: a reference to a std::vector<MIL_INT16> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • array of type short [optionally, in C++: a reference to a std::vector<short> ]
  • char
  • MIL_DOUBLE
  • MIL_FLOAT
  • MIL_ID
  • MIL_INT
  • MIL_INT16
  • MIL_INT32
  • MIL_INT64
  • MIL_TEXT_CHAR

Specifies the address in which to write results.

See the Parameter associations section for possible values that can be returned.

When retrieving a general result (M_GENERAL), the ResultType parameter can be set to one of the following values.

function map For retrieving general results
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CHAR_NUMBER +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_CONTEXT_ID +

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().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_ENCODING +

Retrieves the type of character encoding that MstrRead() used to generate the contents of the result buffer.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_ASCII

Specifies that the characters were encoded with an 8-bit ASCII standard.

Click to summarize M_UNICODE

Specifies that the characters were encoded with a 16-bit Unicode standard.

Click to summarize M_STRING_NUMBER +

Retrieves the total number of strings read.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_TEXT +

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). Note that a string separator is inserted between different strings when getting all strings simultaneously. The string separator can be set using MstrControl() with M_STRING_SEPARATOR. By default, the string separator is a new line (ASCII code 10). Refer to M_STRING to retrieve the strings without separators. Refer to M_FORMATTED_STRING to retrieve the formatted string.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type char [optionally, in C++: a reference to a std::vector<char> ]  |  array of type short [optionally, in C++: a reference to a std::vector<short> ] MORE
Click to summarize M_TEXT_ALLOC_SIZE_BYTE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_TIMEOUT_END +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_FALSE

Specifies that the timeout limit was not reached.

Click to summarize M_TRUE

Specifies that the timeout limit was reached.

When retrieving individual string results, the ResultType parameter can be set to one of the following values. Results can be retrieved for a specific string, or for all strings (M_ALL), unless otherwise specified. Note that strings are ordered in the natural Latin-based reading order.

function map For individual strings
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CHAR_ANGLE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_FOREGROUND_VALUE +

Retrieves the foreground value of the string read.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_FORMATTED_STRING +

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). Note that a space character is inserted between different strings when getting all strings simultaneously. Refer to M_STRING to retrieve the strings without separators. Refer to M_TEXT to retrieve the entire text.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type char [optionally, in C++: a reference to a std::vector<char> ]  |  array of type short [optionally, in C++: a reference to a std::vector<short> ]  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_SKEW_ANGLE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING +

Retrieves the null terminated string found 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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type char [optionally, in C++: a reference to a std::vector<char> ]  |  array of type short [optionally, in C++: a reference to a std::vector<short> ]  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_ALLOC_SIZE_BYTE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_ANGLE +

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 26: Calibrating your camera setup.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_ASPECT_RATIO +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_BL_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_BL_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_BR_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_BR_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_UL_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_UL_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_UR_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_BOX_UR_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_CHAR_NUMBER +

Retrieves the number of characters in the string found during the read operation, not including the terminating null character ("\0"); this means it returns the number of characters with results. In addition, space characters are not counted in the string size.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_CHAR_SCORE_MAX +

Retrieves the maximum character score of the string.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_CHAR_SCORE_MIN +

Retrieves the minimum character score of the string.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_MODEL_INDEX +

Retrieves the index of the string model read.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_MODEL_USER_LABEL +

Retrieves the user label of the string model read.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_POSITION_X +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_POSITION_Y +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_SCALE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_SCORE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_STRING_TARGET_SCORE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Combination value for M_FORMATTED_STRING; M_STRING; M_TEXT.

You can add the following value to the above-mentioned values to get the string's length..

function map For getting the string size
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_STRING_SIZE +

Retrieves the length of one or more strings, including the terminating null character ("\0"). In the case of M_TEXT, it also includes string separators. This combination constant is useful to establish the required array size to retrieve the string.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE

When retrieving results for individual characters of a string, the ResultType parameter can be set to one of the following values. Results can be returned for characters of a specific string or for characters of all (M_ALL) strings. However, an array of results is always returned. Note that characters in the string are ordered by their index position in the string.

function map For individual characters of a string
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_CHAR_ASPECT_RATIO +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BASELINE_DEVIATION +

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 13: 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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_BL_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_BL_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_BR_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_BR_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_UL_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_UL_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_UR_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_BOX_UR_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_CONSECUTIVE_SPACE +

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().

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_FONT +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_FONT_USER_LABEL +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_HOMOGENEITY_SCORE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_INDEX +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_POSITION_X +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_POSITION_Y +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_SCALE +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_SCORE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_SIMILARITY_SCORE +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_CHAR_VALUE +

Retrieves the value of each character read.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type char [optionally, in C++: a reference to a std::vector<char> ]  |  array of type short [optionally, in C++: a reference to a std::vector<short> ] MORE

When retrieving transformation coefficient results for individual characters of a string, the ResultType parameter can be set to one of the following values.

Transformation coefficients allow you to transform any point from the character's source image (the image from which the characters were defined) to its corresponding position in the target image (forward), or from the read position in the target image to its corresponding position in the character's source image (reverse). This is done using the following equations:

x d = A x s + B y s + C

y d = D x s + E y s + F

where A, B, C, D, E, and F are the transformation coefficients (forward or reverse); x s and y s specify the source coordinates (character image for forward transformation or target image for reverse transformation); and, x d and y d specify the destination coordinates (target image for forward transformation or character image for reverse transformation).

function map For retrieving transformation coefficient results for individual characters of a string with a font-based context
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_A_FORWARD +

Retrieves the forward transformation coefficient A.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_A_REVERSE +

Retrieves the reverse transformation coefficient A.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_B_FORWARD +

Retrieves the forward transformation coefficient B.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_B_REVERSE +

Retrieves the reverse transformation coefficient B.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_C_FORWARD +

Retrieves the forward transformation coefficient C.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_C_REVERSE +

Retrieves the reverse transformation coefficient C.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_D_FORWARD +

Retrieves the forward transformation coefficient D.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_D_REVERSE +

Retrieves the reverse transformation coefficient D.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_E_FORWARD +

Retrieves the forward transformation coefficient E.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_E_REVERSE +

Retrieves the reverse transformation coefficient E.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_F_FORWARD +

Retrieves the forward transformation coefficient F.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_F_REVERSE +

Retrieves the reverse transformation coefficient F.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE

When retrieving errors or warnings reported by the last call to MstrExpert(), the ResultType parameter can be set to one of the following values.

To retrieve general errors or warnings (relating to the entire String Reader context), the Index parameter must be set to M_GENERAL. To retrieve errors or warnings for a specific string, or for all strings, the Index parameter must be set to the string's index, or to M_ALL.

function map For retrieving errors or warnings reported by the last call to MstrExpert()
Click to summarize
ResultType
Description
ResultArrayPtr
- Possible values returned
Click to summarize M_REPORT_ERRORS +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_REPORT_NUMBER_OF_ERRORS +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_REPORT_NUMBER_OF_WARNINGS +

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

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_REPORT_WARNINGS +

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.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE

You can add the following value to the above-mentioned values to determine the required array size (number of elements) to store the returned values.

function map For determining the required array size (number of elements) to store the returned values
Click to summarizeResultType combination value Description
ResultArrayPtr
- Possible values returned
Click to summarize M_NB_ELEMENTS

Retrieves the required array size (number of elements) to store the returned values.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE

You can add the following value to the above-mentioned values to determine whether a result is available.

function map For determining whether results are available
Click to summarizeResultType Description
ResultArrayPtr
- Possible values returned
Click to summarize M_AVAILABLE

Retrieves whether a result is available to be returned.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_NULL

Specifies that the result is not available to be retrieved.

Click to summarize Value != 0

Specifies that the result is available to be retrieved.

Combination values for the values listed in For retrieving general results (exceptions might exist); the values listed in For individual strings (exceptions might exist); the values listed in For individual characters of a string (exceptions might exist); the values listed in For retrieving transformation coefficient results for individual characters of a string with a font-based context (exceptions might exist); the values listed in For retrieving errors or warnings reported by the last call to MstrExpert() (exceptions might exist); and for the following value: M_STRING_SIZE.

You can add one of the following values to the above-mentioned values to cast the requested results to a required data type.

Note: In C++, when using a standard vector (std::vector) instead of an array, the values listed in this combination table must not be used. If you need to use a specific data type, instantiate the vector with the necessary data type.

function map For casting the result to a required data type
Click to summarizeResultType Description
ResultArrayPtr
- Possible values returned
Click to summarize M_TYPE_CHAR

Casts the requested results to a char.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a char  |  array of type char [optionally, in C++: a reference to a std::vector<char> ] MORE
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TYPE_MIL_FLOAT

Casts the requested results to a MIL_FLOAT.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_FLOAT  |  array of type MIL_FLOAT [optionally, in C++: a reference to a std::vector<MIL_FLOAT> ] MORE
Click to summarize M_TYPE_MIL_ID

Casts the requested results to a MIL_ID.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_ID  |  array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ] MORE
Click to summarize M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_INT  |  array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TYPE_MIL_INT16

Casts the requested results to a MIL_INT16.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_INT16  |  array of type MIL_INT16 [optionally, in C++: a reference to a std::vector<MIL_INT16> ] MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested results to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_INT32  |  array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_INT64  |  array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
Click to summarize M_TYPE_TEXT_CHAR

Casts the requested results to a MIL_TEXT_CHAR.

(summarize)
Expand data type infoCollapse data type info ResultArrayPtr extra info
Data type info: Data type: address of a MIL_TEXT_CHAR  |  array of type MIL_TEXT_CHAR [optionally, in C++: MIL_STRING ] MORE
Compilation information
Header Include mil.h.
Library Use mil.lib; milstr.lib.
DLL Requires mil.dll; milstr.dll.
DEFAULT ALL GENERAL STRING NUMBER CHAR NUMBER CONTEXT ID ENCODING ASCII UNICODE STRING NUMBER TEXT TEXT ALLOC SIZE BYTE TIMEOUT END FALSE TRUE CHAR ANGLE FOREGROUND VALUE FORMATTED STRING SKEW ANGLE STRING STRING ALLOC SIZE BYTE STRING ANGLE STRING ASPECT RATIO STRING BOX BL X STRING BOX BL Y STRING BOX BR X STRING BOX BR Y STRING BOX UL X STRING BOX UL Y STRING BOX UR X STRING BOX UR Y STRING CHAR NUMBER STRING CHAR SCORE MAX STRING CHAR SCORE MIN STRING MODEL INDEX STRING MODEL USER LABEL STRING POSITION X STRING POSITION Y STRING SCALE STRING SCORE STRING TARGET SCORE STRING SIZE CHAR ASPECT RATIO CHAR BASELINE DEVIATION CHAR BOX BL X CHAR BOX BL Y CHAR BOX BR X CHAR BOX BR Y CHAR BOX UL X CHAR BOX UL Y CHAR BOX UR X CHAR BOX UR Y CHAR CONSECUTIVE SPACE CHAR FONT CHAR FONT USER LABEL CHAR HOMOGENEITY SCORE CHAR INDEX CHAR POSITION X CHAR POSITION Y CHAR SCALE CHAR SCORE CHAR SIMILARITY SCORE CHAR VALUE A FORWARD A REVERSE B FORWARD B REVERSE C FORWARD C REVERSE D FORWARD D REVERSE E FORWARD E REVERSE F FORWARD F REVERSE REPORT ERRORS REPORT NUMBER OF ERRORS REPORT NUMBER OF WARNINGS REPORT WARNINGS NB ELEMENTS AVAILABLE NULL TYPE CHAR TYPE MIL DOUBLE TYPE MIL FLOAT TYPE MIL ID TYPE MIL INT TYPE MIL INT16 TYPE MIL INT32 TYPE MIL INT64 TYPE TEXT CHAR GENERAL GENERAL ALL DEFAULT ALL DEFAULT ASCII UNICODE