Table: | For a context or an individual string |
Table: | For a context or a specific font |
Table: | For a String reader context |
Table: | For an individual string |
Table: | For an individual string when specifying constraints |
+ combination: | For getting the string size |
+ combination: | For M_CONSTRAINT to specify the index |
Table: | For an individual font |
+ combination: | For the default value of an inquire type |
Table: | For specifying the result for MstrGetResult() |
Table: | For inquiring about the system |
Table: | For retrieving the meaning of an error or warning report value generated by MstrExpert() |
+ combination: | For determining the required array size (number of elements) to store the returned values |
+ combination: | For inquiring whether an inquire type is supported |
Table: | For user label inquiries |
+ combination: | For specifying the data type |
MIL_ID ContextOrResultId, | //in |
MIL_INT Index, | //in |
MIL_INT64 InquireType, | //in |
void *UserVarPtr | //out |
This function inquires information about a String Reader context, the string models or fonts contained therein, or a result buffer. In addition, this function can inquire from the String Reader context the meaning of an error/warning code generated by MstrExpert() and retrieved using MstrGetResult() with M_REPORT_ERRORS or M_REPORT_WARNINGS.
Unless otherwise specified, the inquire type settings are applicable to both font-based and fontless contexts.
If the inquired setting is set to M_DEFAULT (for example, in MstrControl()), MstrInquire() will return M_DEFAULT. To inquire the actual default value, add M_DEFAULT to the InquireType parameter.
Specifies the String Reader context or result buffer about which to inquire information. The String Reader context must have been previously allocated on the required system using MstrAlloc(). The String Reader result buffer must have been previously allocated on the required system using MstrAllocResult().
Specifies that information will be inquired about the String Reader context, a specific font, a specific string model, a specified error/warning code, or a result buffer. Set this parameter to one of the following values:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the default. If a String Reader context is specified, same as M_CONTEXT. If a String Reader result buffer is specified, same as M_GENERAL. (summarize)Specifies the default. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the index of the font about which to inquire. Note that this macro is only available for a font-based context. (summarize)Specifies the index of the font about which to inquire. (more details...) |
||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
This parameter specifies the index of the font. You can set this parameter to the following: |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the index of the string about which to inquire. (summarize)Specifies the index of the string about which to inquire. (more details...) |
||||||||||||||||||||||||||||||||||||||
Parameters | |||||||||||||||||||||||||||||||||||||||
This parameter specifies the index of the string. You can set this parameter to the following: |
|||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to inquire information about a general setting of a String Reader context. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies to inquire information about a general setting of a String Reader result buffer. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the error or warning code about which to inquire. Typically, these codes are generated by the last call to MstrExpert(), and retrieved using MstrGetResult() with either M_REPORT_ERRORS or M_REPORT_WARNINGS. (summarize)Specifies the error or warning code about which to inquire. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Specifies the label of the font or string about which to inquire, assigned using MstrControl(). Set InquireType to either M_FONT_INDEX_FROM_LABEL or M_STRING_INDEX_FROM_LABEL to retrieve the font or string index associated with the user label, respectively. (summarize)Specifies the label of the font or string about which to inquire, assigned using MstrControl(). (more details...) |
Specifies the type of setting about which to inquire.
See the Parameter associations section for possible values that can be specified.
Specifies the address in which to write the requested information. Since the MstrInquire() function also returns the requested information, you can set this parameter to M_NULL.
See the Parameter associations section for possible values that can be returned.
The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.
For a String Reader context (M_CONTEXT), or a specific string in the String Reader context (M_STRING_INDEX()), the InquireType parameter can be set to the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)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 (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that all strings will be read. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the maximum number of strings that can be read. INFO |
For a fontless context (M_CONTEXT), or font-based context (M_FONT_INDEX()), the InquireType parameter can be set to the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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). (summarize)Inquires the character value for each character. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the value of the character. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the number of characters in the font-based or fontless context. (summarize)Inquires the number of characters in the font-based or fontless context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the number of characters. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the width of the space character of the font or fontless context. SET (summarize)Inquires the width of the space character of the font or fontless context. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_MEAN_CHAR_WIDTH. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the width of the space character is infinite. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the width of the space character is equal to the maximum character X-size of the font. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the width of the space character is equal to the average character X-size of the font. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the width of the space character is equal to the minimum character X-size of the font. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the width of the space character is equal to a quarter of the maximum character width of the font. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the width of the space character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the actual width value of the space character of the font or fontless context. (summarize)Inquires the actual width value of the space character of the font or fontless context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the actual width value of the space character, in pixels. |
For a String Reader context (M_CONTEXT), the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)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. SET SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies not to search for the character when performing a read operation. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to search for the character when performing a read operation. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the type of String Reader context. (summarize)Inquires the type of String Reader context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a font-based context. Such contexts must be allocated, using MstrAlloc(). (summarize)Specifies a font-based context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a fontless context. Such contexts must be restored, using MstrRestore(). (summarize)Specifies a fontless context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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(). (summarize)Inquires the width of the image buffer needed by the last call to MstrDraw(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the width of the image buffer. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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(). (summarize)Inquires the height of the image buffer needed by the last call to MstrDraw(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the height of the image buffer. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the type of character encoding used by the String Reader context. SET (summarize)Inquires the type of character encoding used by the String Reader context. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_ASCII. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an 8-bit ASCII standard. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a 16-bit Unicode standard. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)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. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 65 pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the maximum character width, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)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. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 6 pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the minimum character width, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)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 (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 15. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the minimum contrast. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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. (summarize)Inquires the current value of the modification counter. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the current value of the modification counter. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the number of fonts in the context. Note that this inquire type is only available for a font-based context. (summarize)Inquires the number of fonts in the context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the number of fonts. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the number of string models in the context. (summarize)Inquires the number of string models in the context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the number of string models. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether the String Reader context is preprocessed. This will indicate whether preprocessing (using MstrPreprocess()) is needed to prepare the context for use. (summarize)Inquires whether the String Reader context is preprocessed. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_DOUBLE
MORE
Data type info: Data
type: address of a MIL_DOUBLE
MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the context is not preprocessed; you should preprocess again. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the context is preprocessed; you should not preprocess again. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the reference height. Note that this inquire type is only available for a fontless context. SET (summarize)Inquires the reference height. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 46 pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the height, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the stroke width of characters in the fontless context when they have a height of M_REF_CHAR_SIZE_Y. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 6 pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the thickness, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether strategies specific to angular-range will be calculated. SET (summarize)Inquires whether strategies specific to angular-range will be calculated. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_DISABLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies not to perform calculations specific to angular-range search strategies. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to perform calculations specific to angular-range search strategies. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether strategies specific to angular-range skew will be calculated. SET (summarize)Inquires whether strategies specific to angular-range skew will be calculated. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_DISABLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies not to perform calculations specific to angular-range skew search strategies. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to perform calculations specific to angular-range skew search strategies. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether to search for the string angle. SET (summarize)Inquires whether to search for the string angle. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_ENABLE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies not to search for the string angle. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to search for the string angle. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the character value to use as a space character within the formatted text that will be read. SET (summarize)Inquires the character value to use as a space character within the formatted text that will be read. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is numerical ASCII code 32. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies no space character. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the space character, as its numerical code (ASCII or Unicode). INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the search/read speed. SET (summarize)Inquires the search/read speed. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_MEDIUM. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a high speed. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a medium speed. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the character value to use as a string separator within the formatted text that will be read. SET (summarize)Inquires the character value to use as a string separator within the formatted text that will be read. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is numerical ASCII code 10. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies no separator character. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the separator character, as its numerical code (ASCII or Unicode). INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the number of character thickening iterations. SET (summarize)Inquires the number of character thickening iterations. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 0. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the number of character thickening iterations. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the threshold method of the character blob extraction. SET (summarize)Inquires the threshold method of the character blob extraction. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_LOCAL_WITH_RESEGMENTATION. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies local thresholding that uses only one threshold step that is automatically computed by the module. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies local thresholding that uses multiple threshold steps and split and merge techniques. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies global thresholding that uses the threshold value set with M_THRESHOLD_VALUE. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the global threshold value when M_THRESHOLD_MODE is set to M_USER_DEFINED (otherwise it is ignored). SET (summarize)Inquires the global threshold value when M_THRESHOLD_MODE is set to M_USER_DEFINED (otherwise it is ignored). SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_AUTO_COMPUTE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to automatically compute the global threshold value. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the threshold value. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the maximum read time for MstrRead(), in msec. SET (summarize)Inquires the maximum read time for MstrRead(), in msec. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 2000.0 msec. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an infinite amount of read time. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the maximum read time, in msec. |
For a specific string (M_STRING_INDEX()) in the String Reader context, the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the acceptance level for the character score. SET (summarize)Inquires the acceptance level for the character score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 50.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an acceptable score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the upper limit of the aspect ratio for the characters in the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1.1. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the maximum aspect ratio of the characters in the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the lower limit of the aspect ratio for the characters in the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 0.9. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the minimum aspect ratio of the characters in the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the acceptance level for the character's homogeneity score. SET (summarize)Inquires the acceptance level for the character's homogeneity score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 50.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an acceptable score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the maximum deviation that a character can have from the string's baseline. SET (summarize)Inquires the maximum deviation that a character can have from the string's baseline. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 10. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the character's maximum baseline deviation within the string model. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the factor used to determine the upper limit (maximum permitted scale) of the scale range for the characters in the string. SET (summarize)Inquires the factor used to determine the upper limit (maximum permitted scale) of the scale range for the characters in the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1.1. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the maximum scale of the characters in the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the factor used to determine the lower limit (minimum permitted scale) of the scale range for the characters in the string. SET (summarize)Inquires the factor used to determine the lower limit (minimum permitted scale) of the scale range for the characters in the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 0.9. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the minimum scale of the characters in the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the acceptance level for the character's similarity score. SET (summarize)Inquires the acceptance level for the character's similarity score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 50.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an acceptable score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the font index for each default font constraint. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the index of the individual font from which the constraint is taken. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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. (summarize)Inquires the default constraint type. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default constraint type. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the foreground color of the string. SET (summarize)Inquires the foreground color of the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_FOREGROUND_BLACK. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that black is the foreground color of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the foreground color of the string can be either black or white. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that white is the foreground color of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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(). (summarize)Inquires the number of positions in the string that have a non-default constraint. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the number of positions that have a constraint. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the maximum number of consecutive space characters allowed in the string. SET (summarize)Inquires the maximum number of consecutive space characters allowed in the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 3. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the maximum number of consecutive space characters. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the acceptance level for the string score. SET (summarize)Inquires the acceptance level for the string score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 50.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an acceptable score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the nominal angle of the string. SET (summarize)Inquires the nominal angle of the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_ACCORDING_TO_REGION. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies to set the nominal angle to the angle of the rectangular ROI (set using MbufSetRegion()) in the image. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the lower limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET (summarize)Inquires the lower limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 10.0 °. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the lower limit of the angular range, in degrees. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the upper limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET (summarize)Inquires the upper limit of the string's angular range, relative to the nominal angle (MstrControl() with M_STRING_ANGLE). SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 10.0 °. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the upper limit of the angular range, in degrees. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the nominal aspect ratio of the string. Note that this inquire type is only available for a font-based context. SET (summarize)Inquires the nominal aspect ratio of the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1.0. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the ratio of pixel width to pixel height of the target. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the upper limit of the string's aspect ratio. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1.25. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the maximum aspect ratio of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the lower limit of the string's aspect ratio. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 0.8. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the minimum aspect ratio of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the certainty level for the string score. SET (summarize)Inquires the certainty level for the string score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 70.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the certainty level for the string score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the nominal scale of the string. SET (summarize)Inquires the nominal scale of the string. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1.0. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the value of the scale. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the upper limit (maximum permitted scale) of the string's scale range. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 2.0. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the minimum scale of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the factor used to determine the lower limit (minimum permitted scale) of the string's scale range. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 0.5. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the factor that determines the minimum scale of the string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the maximum string size (number of characters) of the string model. SET (summarize)Inquires the maximum string size (number of characters) of the string model. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_INFINITE. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies no maximum string size. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the maximum string size. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the minimum string size (number of characters) of the string model. SET (summarize)Inquires the minimum string size (number of characters) of the string model. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 1. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the minimum string size. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the acceptance level for the string target score. SET (summarize)Inquires the acceptance level for the string target score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 50.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies an acceptable string target score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the certainty level for the string target score. SET (summarize)Inquires the certainty level for the string target score. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 70.0 %. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the certainty level for the string target score, as a percentage. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the type of the string model added to the String Reader context. SET (summarize)Inquires the type of the string model added to the String Reader context. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_USER_DEFINED. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a user-defined type of string model. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the string model's user-defined label. SET (summarize)Inquires the string model's user-defined label. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_NO_LABEL. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that no user label is associated with the string model. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the user label of the string model. INFO |
For a specific string (M_STRING_INDEX()) in the String Reader context, the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 You must specify a combination value from the following table: Inquires the constraint string at the specified index. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the constraint string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the allocation size needed for each non-default constraint string. The allocation size of the constraint string includes the terminating null character ("\0"). (summarize)Inquires the allocation size needed for each non-default constraint string. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the size needed when retrieving the specified constraint string. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the font index for each non-default constraint of the string model. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the index of the individual font from which the constraint is taken. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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. (summarize)Inquires the position of each non-default constraint in the string model (0, 255). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the position of the constraint. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the constraint's type. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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. (summarize)Inquires the default constraint string. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default constraint string. |
You can add the following value to the above-mentioned values to get the string's length.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the length of the constraint string, including the terminating null character ("\0"). (summarize)Retrieves the length of the constraint string, including the terminating null character ("\0"). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
You must add the following value to the above-mentioned value to get the constraint string at the specified index.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the constraint string at the specified index. The index you provide is the index of the constraint in the list of non-default constraints, and not its actual position in the string model. You can inquire the position in the string model that this constraint string applies to using MstrInquire() with M_CONSTRAINT_POSITION. (summarize)Inquires the constraint string at the specified index. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
For a specific font (M_FONT_INDEX()) in the String Reader context, the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the setting for the baseline value for each character. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the baseline was automatically computed to an appropriate value. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies no baseline. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the baseline value, as a percentage of the character's height. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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 (summarize)Inquires the baseline value for each character. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies no baseline. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the baseline value, as a percentage of the character's height. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the X-size of each character in the font. SET SET (summarize)Inquires the X-size of each character in the font. SET SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the X-size of the character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the Y-size of each character in the font. SET SET (summarize)Inquires the Y-size of each character in the font. SET SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the Y-size of the character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the average thickness of each character in the font. SET (summarize)Inquires the average thickness of each character in the font. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the thickness of the character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the type of each character in the font. SET (summarize)Inquires the type of each character in the font. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the characters' type was computed automatically. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies punctuation type characters. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies regular type characters. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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. (summarize)Inquires the type value of each character in the font. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies punctuation type characters. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies regular type characters. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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). (summarize)Inquires the X-offset for each character in the font. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the font in the String Reader context is a system font (MstrEditFont() with M_SYSTEM_FONT). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the X-offset of the character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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). (summarize)Inquires the Y-offset for each character in the font. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
Data type info: Data
type: array of type MIL_DOUBLE [optionally, in C++:
a reference to a std::vector<MIL_DOUBLE>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the font in the String Reader context is a system font (MstrEditFont() with M_SYSTEM_FONT). |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the Y-offset of the character, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the margin in the X-direction, between the character box and the drawing box. SET (summarize)Inquires the margin in the X-direction, between the character box and the drawing box. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 3. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the horizontal margin, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the margin in the Y-direction, between the character box and the drawing box. SET (summarize)Inquires the margin in the Y-direction, between the character box and the drawing box. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default value; the default value is 3. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the vertical margin, in pixels. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the type of font added. SET (summarize)Inquires the type of font added. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_USER_DEFINED. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a user-defined type of font. INFO |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the font's user-defined label. SET (summarize)Inquires the font's user-defined label. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Same as M_NO_LABEL. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that no user label is associated with the font. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the user label of the font. INFO |
You can add the following value to the above-mentioned values to determine the default value of an inquire type, regardless of the current value of the inquire type.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the actual default value of the specified inquire type. (summarize)Inquires the actual default value of the specified inquire type. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
For a string result buffer (M_GENERAL), the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether results are returned in pixel or world units. SET (summarize)Inquires whether results are returned in pixel or world units. SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that results are returned in world units if the result was calculated on an image associated with a camera calibration context; otherwise, specifies that results are returned in pixel units. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that results are returned in pixel units, with respect to the pixel coordinate system. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that results are returned in world units, with respect to the relative coordinate system. INFO |
To inquire about the system on which the String Reader context or result buffer has been allocated, set the InquireType parameter to the value below.
Note that the Index parameter must be set to M_CONTEXT for a String Reader context or to M_GENERAL for a result buffer.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the identifier of the system on which the String Reader context or result buffer was allocated. SET SET (summarize)Inquires the identifier of the system on which the String Reader context or result buffer was allocated. SET SET (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_DOUBLE
MORE
Data type info: Data
type: address of a MIL_DOUBLE
MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the default Host system of the current MIL application. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies a valid system identifier, previously allocated using MsysAlloc(). |
For retrieving the meaning of an error or warning code generated by MstrExpert(), and retrieved using MstrGetResult() with M_REPORT_..., the InquireType parameter can be set to the following value.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the error message associated with an error or warning code generated by MstrExpert(). (summarize)Inquires the error message associated with an error or warning code generated by MstrExpert(). (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
|
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.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Retrieves the required array size (number of elements) to store the returned values. (summarize)Retrieves the required array size (number of elements) to store the returned values. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_DOUBLE
MORE
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 an inquire type is supported.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires whether the specified inquire type is supported for the String Reader context. (summarize)Inquires whether the specified inquire type is supported for the String Reader context. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the inquire type is not supported. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the inquire type is supported. |
For user label inquiries, the InquireType parameter can be set to one of the following:
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the font index associated with a font user label if the user label is used. Note that this inquire type is only available for a font-based context. (summarize)Inquires the font index associated with a font user label if the user label is used. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the user label is invalid. This is returned if the specified user label is not associated with a font. (summarize)Specifies that the user label is invalid. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the font index associated with the specified user label. |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Inquires the string model index associated with a string model user label if the user label is used. (summarize)Inquires the string model index associated with a string model user label if the user label is used. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a
MIL_DOUBLE
Data type info: Data
type: address of a
MIL_DOUBLE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies that the user label is invalid. This is returned if the specified user label is not associated with a string model. (summarize)Specifies that the user label is invalid. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() |
Specifies the string model index associated with the specified user label. |
You can add one of the following values to the above-mentioned values to cast the requested results to the 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.
![]() |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Description | ||||||||||||||||||||||||||||||||||||||
UserVarPtr - Possible values returned |
|||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a char. (summarize)Casts the requested results to a char. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a char
| array of type char [optionally, in
C++: a reference to a std::vector<char>
] MORE
Data type info: Data
type: address of a char
| array of type char [optionally, in
C++: a reference to a std::vector<char>
] MORE
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_DOUBLE. (summarize)Casts the requested results to a MIL_DOUBLE. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_FLOAT. (summarize)Casts the requested results to a MIL_FLOAT. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_ID. (summarize)Casts the requested results to a MIL_ID. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_INT. (summarize)Casts the requested results to a MIL_INT. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_INT16. (summarize)Casts the requested results to a MIL_INT16. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_INT32. (summarize)Casts the requested results to a MIL_INT32. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_INT64. (summarize)Casts the requested results to a MIL_INT64. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
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
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
|
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Casts the requested results to a MIL_TEXT_CHAR. (summarize)Casts the requested results to a MIL_TEXT_CHAR. (more details...) |
||||||||||||||||||||||||||||||||||||||
![]() ![]() |
Data type info: Data
type: address of a MIL_TEXT_CHAR
| array of type MIL_TEXT_CHAR
[optionally, in C++: MIL_STRING ]
MORE
Data type info: Data
type: address of a MIL_TEXT_CHAR
| array of type MIL_TEXT_CHAR
[optionally, in C++: MIL_STRING ]
MORE
|
Header | Include mil.h. |
Library | Use mil.lib; milstr.lib. |
DLL | Requires mil.dll; milstr.dll. |