Filters
Filter values by
  • Context inquires
  • Result buffer inquires
| Customize Help
| Save Settings

MdmrInquire


Function Map
Syntax
Description
Parameters
- ContextOrResultDmrId
- InquireType
- UserVarPtr
Parameter Associations
Table: For inquiring about a SureDotOCR context
Table: For inquiring about a SureDotOCR result buffer
+ combination: For inquiring the default value
+ combination: For inquiring if an inquire type is supported
+ combination: For casting information to the required data type.
Return value
Compilation information
Synopsis
Inquire about a SureDotOCR context or result buffer setting.
Syntax
MIL_INT MdmrInquire(
MIL_ID ContextOrResultDmrId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a setting of a SureDotOCR context or result buffer. Such settings are typically specified with MdmrControl().

If the inquired setting is set to M_DEFAULT (for example, in MdmrControl()), MdmrInquire() will return M_DEFAULT. To inquire the actual default value, add M_DEFAULT to the InquireType parameter.

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
ContextOrResultDmrId

Specifies the identifier of the SureDotOCR context or result buffer about which to inquire. The context must have been previously allocated on the system using MdmrAlloc(). The result buffer must have been previously allocated on the system using MdmrAllocResult().

InquireType

Specifies the setting to inquire.

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

UserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MdmrInquire() 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.

Parameter associations

The tables below list possible values for the InquireType parameter and possible values returned to the UserVarPtr parameter.

To inquire about the SureDotOCR context specified with the ContextOrResultDmrId parameter, set the InquireType parameter to one of the values below. SureDotOCR can only read strings that adhere to these settings (they apply to all string models in the context).

function map For inquiring about a SureDotOCR context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_DOT_DIAMETER +

Inquires the diameter of the dots that make up the characters in the strings. SET

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

Specifies an invalid diameter. Set the diameter to a valid value, using MdmrControl() with M_DOT_DIAMETER.

(summarize)
Click to summarize Value > 0.0

Specifies the diameter, in pixels.
Click to summarize M_FOREGROUND_VALUE +

Inquires the foreground value of the characters in the strings. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_FOREGROUND_BLACK.
Click to summarize M_FOREGROUND_BLACK

Specifies that strings with characters darker than the background will be read. INFO
Click to summarize M_FOREGROUND_WHITE

Specifies that strings with characters lighter than the background will be read. INFO
Click to summarize M_ITALIC_ANGLE +

Inquires the italic angle at which to read the characters in the strings. M_ITALIC_ANGLE only has an effect if M_ITALIC_ANGLE_MODE is set to M_ANGLE. SET

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

Specifies the default value; the default value is 0.
Click to summarize -90.0 <= Value <= 90.0

Specifies the italic angle, in degrees. INFO
Click to summarize M_ITALIC_ANGLE_MODE +

Inquires whether the italic angle is detected automatically or explicitly specified. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is M_AUTO.
Click to summarize M_ANGLE

Specifies to use the italic angle specified with M_ITALIC_ANGLE. INFO
Click to summarize M_AUTO

Specifies that the italic angle is detected automatically. INFO
Click to summarize M_ITALIC_PITCH +

Inquires the distance between successive dot centers, in the italic angle direction, at which to read the characters in the strings. M_ITALIC_PITCH only has an effect if M_ITALIC_PITCH_MODE is set to M_USER_DEFINED. SET

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

Specifies the default value; the default value is 3.0 pixels.
Click to summarize Value > 0.0

Specifies the pitch, in pixels.
Click to summarize M_ITALIC_PITCH_MODE +

Inquires whether the distance between successive dot centers, in the italic angle direction, is detected automatically or explicitly specified. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is M_AUTO.
Click to summarize M_AUTO

Specifies to automatically establish the distance between dot centers in the italic angle direction.
Click to summarize M_USER_DEFINED

Specifies to use the value set with M_ITALIC_PITCH. INFO
Click to summarize M_MAX_INTENSITY +

Inquires the maximum pixel intensity of a character's dots. SET

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

Specifies the default value; the default value is 255.0.
Click to summarize 0.0 <= Value <= 255.0

Specifies the maximum pixel intensity.
Click to summarize M_MAX_INTENSITY_MODE +

Inquires how to establish the maximum pixel intensity of a character's dots. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_AUTO.
Click to summarize M_AUTO

Specifies to automatically establish the maximum pixel intensity of a character's dots. INFO
Click to summarize M_USER_DEFINED

Specifies to use the maximum pixel intensity value set with M_MAX_INTENSITY.
Click to summarize M_MIN_CONTRAST +

Inquires the minimum contrast between a character and its background. SET

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

Specifies the default value; the default value is 15.0.
Click to summarize 0.0 <= Value <= 255.0

Specifies the minimum contrast.
Click to summarize M_MIN_CONTRAST_MODE +

Inquires how to establish the minimum contrast between a character and its background. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_AUTO.
Click to summarize M_AUTO

Specifies to automatically establish the minimum contrast of characters. INFO
Click to summarize M_USER_DEFINED

Specifies to use the minimum contrast value set with M_MIN_CONTRAST.
Click to summarize M_MIN_INTENSITY +

Inquires the minimum pixel intensity of a character's dots. SET

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

Specifies the default value; the default value is 0.0.
Click to summarize 0.0 <= Value <= 255.0

Specifies the minimum pixel intensity.
Click to summarize M_MIN_INTENSITY_MODE +

Inquires how to establish the minimum pixel intensity of a character's dots. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_AUTO.
Click to summarize M_AUTO

Specifies to automatically establish the minimum pixel intensity of character dots. INFO
Click to summarize M_USER_DEFINED

Specifies to use the minimum pixel intensity value set with M_MIN_INTENSITY.
Click to summarize M_MODIFICATION_COUNT +

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)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value

Specifies the current value of the modification counter.
Click to summarize M_NUMBER_OF_FONTS +

Inquires the number of fonts in the context. To add and remove fonts, use MdmrControl(). To import fonts, use MdmrImportFont().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the number of fonts.
Click to summarize M_NUMBER_OF_STRING_MODELS +

Inquires the number of string models in the context. To add and remove string models, use MdmrControl().

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize Value >= 0

Specifies the number of string models.
Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the context was allocated. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.
Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().
Click to summarize M_PREPROCESSED +

Inquires whether the context is preprocessed. The context must be preprocessed, using MdmrPreprocess(), before calling MdmrRead(). After certain modifications to the context, as can be done with MdmrControl(), MdmrControlFont(), or MdmrControlStringModel(), this inquire type will indicate that the context is no longer in its preprocessed state.

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

Specifies that the context is not preprocessed.
Click to summarize M_TRUE

Specifies that the context is preprocessed.
Click to summarize M_SPACE_SIZE_MAX +

Inquires the value with which to determine the maximum distance between two characters in a string. SET

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

Specifies the default value; the default value is 3.0.
Click to summarize Value > 0.0

Specifies the maximum distance value.
Click to summarize M_SPACE_SIZE_MAX_MODE +

Inquires how to determine the maximum distance between two characters in a string. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_CHAR_WIDTH_FACTOR.
Click to summarize M_CHAR_WIDTH_FACTOR

Specifies that the maximum distance between two characters in a string is determined by multiplying the M_SPACE_SIZE_MAX value by the string's maximum character width, in pixels. INFO
Click to summarize M_DISABLE

Specifies no maximum space size. INFO
Click to summarize M_SPACE_SIZE_MIN +

Inquires the value with which to determine the minimum distance between two characters in a string. SET

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

Specifies the default value; the default value is 1.0.
Click to summarize Value > 0.0

Specifies the minimum distance value.
Click to summarize M_SPACE_SIZE_MIN_MODE +

Inquires how to determine the minimum distance between two characters in a string. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_CHAR_WIDTH_FACTOR.
Click to summarize M_CHAR_WIDTH_FACTOR

Specifies that the minimum distance between two characters in a string is determined by multiplying the M_SPACE_SIZE_MIN value by the string's maximum character width, in pixels. INFO
Click to summarize M_DISABLE

Specifies no minimum space size. INFO
Click to summarize M_STRING_ANGLE +

Inquires the angle at which to read a string. SET

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

Specifies the default value; the default value is 0.
Click to summarize M_ACCORDING_TO_REGION

Specifies that the angle is set to the angle of the target image's ROI. INFO
Click to summarize 0.0 <= Value <= 360.0

Specifies a fixed angle at which to read a string, in degrees. INFO
Click to summarize M_STRING_ANGLE_INPUT_UNITS +

Inquires the coordinate system that is used for M_STRING_ANGLE. This is ignored when M_STRING_ANGLE is set to M_ACCORDING_TO_REGION. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_PIXEL.
Click to summarize M_PIXEL

Specifies to interpret the value in pixel units, with respect to the pixel coordinate system.
Click to summarize M_WORLD

Specifies to interpret the value in world units, with respect to the relative coordinate system.
Click to summarize M_STRING_ANGLE_MODE +

Inquires whether the string angle is detected automatically or explicitly specified. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is M_AUTO.
Click to summarize M_ANGLE

Specifies to use the angle specified with M_STRING_ANGLE; the string will be read from left to right with the characters facing upward along the specified angle. INFO
Click to summarize M_AUTO

Specifies that the string angle is detected automatically; M_STRING_ANGLE is ignored.
Click to summarize M_ORIENTATION

Specifies that the string will be read from left to right with the characters facing upward, or from right to left with the character facing downward. INFO
Click to summarize M_STRING_BOX_HEIGHT +

Inquires the height of the rectangular region that encloses the strings to read. SET

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

Specifies an invalid height. Set the height to a valid value, using MdmrControl() with M_STRING_BOX_HEIGHT.

(summarize)
Click to summarize Value > 0.0

Specifies the height, in pixels.
Click to summarize M_STRING_BOX_SIZE_MODE +

Inquires how to establish the size of the rectangular region that encloses the strings to read. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Same as M_USER_DEFINED.
Click to summarize M_USER_DEFINED

Specifies that the size of the rectangular region in which to read strings is defined by the M_STRING_BOX_HEIGHT and M_STRING_BOX_WIDTH settings.
Click to summarize M_STRING_BOX_WIDTH +

Inquires the width of the rectangular region that encloses the strings to read. SET

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

Specifies an invalid width. Set the width to a valid value, using MdmrControl() with M_STRING_BOX_WIDTH.

(summarize)
Click to summarize Value > 0.0

Specifies the width, in pixels.
Click to summarize M_STRING_PITCH +

Inquires the distance between successive dot centers, in the string angle direction, at which to read the characters in the strings. M_STRING_PITCH only has an effect if M_STRING_PITCH_MODE is set to M_USER_DEFINED. SET

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

Specifies the default value; the default value is 3.0 pixels.
Click to summarize Value > 0.0

Specifies the pitch, in pixels.
Click to summarize M_STRING_PITCH_MODE +

Inquires whether the distance between successive dot centers, in the string angle direction, is detected automatically or explicitly specified. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_DEFAULT

Specifies the default value; the default value is M_AUTO.
Click to summarize M_AUTO

Specifies to automatically establish the distance between dot centers in the string angle direction.
Click to summarize M_USER_DEFINED

Specifies to use the value set with M_STRING_PITCH. INFO
Click to summarize M_TIMEOUT +

Inquires the maximum read time for MdmrRead(). SET

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

Specifies the default value; the default value is 2000.0 msec.
Click to summarize M_DISABLE

Specifies an infinite amount of read time.
Click to summarize Value >= 0.0

Specifies the maximum read time, in msec.

To inquire about the SureDotOCR result buffer specified with the ContextOrResultDmrId parameter, set the InquireType parameter to one of the values below.

function map For inquiring about a SureDotOCR result buffer
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_RESULT_OUTPUT_UNITS +

Inquires whether to return results in pixels or world units. SET

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_ACCORDING_TO_CALIBRATION

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.
Click to summarize M_PIXEL

Specifies that results are returned in pixel units, with respect to the pixel coordinate system.
Click to summarize M_WORLD

Specifies that results are returned in world units, with respect to the relative coordinate system. INFO
Combination value for the values listed in For inquiring about a SureDotOCR context; the values listed in For inquiring about a SureDotOCR result buffer.

You can add the following value to the above-mentioned values to get the default value of an inquire type, regardless of the current value of the inquire type.

function map For inquiring the default value
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_DEFAULT

Inquires the default value of the specified inquire type.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_DOUBLE
Combination value for the values listed in For inquiring about a SureDotOCR context; the values listed in For inquiring about a SureDotOCR result buffer.

You can add the following value to the above-mentioned values to determine whether an inquire type is supported for the SureDotOCR context currently being inquired.

function map For inquiring if an inquire type is supported
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_SUPPORTED

Inquires whether the specified inquire type is supported.

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

Specifies that the inquire type is not supported.
Click to summarize M_TRUE

Specifies that the inquire type is supported.
Combination values for the values listed in For inquiring about a SureDotOCR context; the values listed in For inquiring about a SureDotOCR result buffer.

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

function map For casting information to the required data type.
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

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

Casts the requested information to a MIL_ID. Note that M_TYPE_MIL_ID should only be used with M_OWNER_SYSTEM.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_ID
Click to summarize M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT
Click to summarize M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT32
Click to summarize M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Expand data type infoCollapse data type info UserVarPtr extra info
Data type info: Data type: address of a MIL_INT64
Return value
The returned value is the requested information, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.
Compilation information
Header Include mil.h.
Library Use mil.lib; mildmr.lib.
DLL Requires mil.dll; mildmr.dll.
DOT DIAMETER INVALID FOREGROUND VALUE DEFAULT FOREGROUND BLACK FOREGROUND WHITE ITALIC ANGLE DEFAULT ITALIC ANGLE MODE DEFAULT ANGLE AUTO ITALIC PITCH DEFAULT ITALIC PITCH MODE DEFAULT AUTO USER DEFINED MAX INTENSITY DEFAULT MAX INTENSITY MODE DEFAULT AUTO USER DEFINED MIN CONTRAST DEFAULT MIN CONTRAST MODE DEFAULT AUTO USER DEFINED MIN INTENSITY DEFAULT MIN INTENSITY MODE DEFAULT AUTO USER DEFINED MODIFICATION COUNT NUMBER OF FONTS NUMBER OF STRING MODELS OWNER SYSTEM DEFAULT HOST PREPROCESSED FALSE TRUE SPACE SIZE MAX DEFAULT SPACE SIZE MAX MODE DEFAULT CHAR WIDTH FACTOR DISABLE SPACE SIZE MIN DEFAULT SPACE SIZE MIN MODE DEFAULT CHAR WIDTH FACTOR DISABLE STRING ANGLE DEFAULT ACCORDING TO REGION STRING ANGLE INPUT UNITS DEFAULT PIXEL WORLD STRING ANGLE MODE DEFAULT ANGLE AUTO ORIENTATION STRING BOX HEIGHT INVALID STRING BOX SIZE MODE DEFAULT USER DEFINED STRING BOX WIDTH INVALID STRING PITCH DEFAULT STRING PITCH MODE DEFAULT AUTO USER DEFINED TIMEOUT DEFAULT DISABLE RESULT OUTPUT UNITS ACCORDING TO CALIBRATION PIXEL WORLD DEFAULT SUPPORTED FALSE TRUE TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64