Filters
Filter values by
Object Type
  • Code context
  • Code model
  • Code result buffer
Code Type
  • 1D code types
  • 2D code types
    • Cross-row code types (PDF)
    • Matrix code types (Aztec, Data Matrix, Maxi, QR)
  • Composite code types
Operation Type
  • Code read operation
  • Code grade operation
  • Code detect operation
  • Code train operation
    • Inquiring what affects the results of training
    • Inquiring about activation
  • Code write operation
| Customize Help
| Save Settings

McodeInquire


Function Map
Syntax
Description
Parameters
- ContextOrResultCodeId
- InquireType
- UserVarPtr
Parameter Associations
Table: For inquiring about code context or result buffer settings
+ combination: For determining the required array size (number of elements) to store the returned values
Table: For inquiring about the number of code models in a code context
Table: For inquiring about code context settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation
Table: For inquiring about code context settings that affect an McodeGrade() operation
Table: For inquiring about code context settings that affect an McodeTrain() operation
Table: For inquiring about a code model's code type
Table: For inquiring about code model settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation
Table: For inquiring about code model settings that affect an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation
+ combination: For inquiring whether the corresponding control type is activated for training
Table: For inquiring about code model settings that affect an McodeGrade() operation
Table: For inquiring about code model settings that affect an McodeWrite() operation
Table: For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation
Table: For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation
+ combination: For inquiring whether an inquire type is supported
+ combination: For inquiring about the default value of an inquire type
+ combination: For specifying the data type
Return value
Compilation information
Synopsis
Inquire about a code context, code model, or code result setting.
Syntax
MIL_INT McodeInquire(
MIL_ID ContextOrResultCodeId, //in
MIL_INT64 InquireType, //in
void *UserVarPtr //out
)
Description

This function inquires about a setting of the specified code context, code model, or code result buffer.

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
ContextOrResultCodeId

Specifies the identifier of the code context, code model, or code result buffer.

InquireType

Specifies the setting about which 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):
  • array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to return the value of the inquired setting. Since the McodeInquire() 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 general code context settings or code result buffer settings, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code context or code result buffer.

function map For inquiring about code context or result buffer settings
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the code context or code result buffer has been allocated. SET 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_SUPPORTED_CODE_TYPES +

Inquires all code types supported.

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

Specifies a 4-state code type.
Click to summarize M_AZTEC

Specifies an Aztec code type. INFO
Click to summarize M_BC412

Specifies a BC412 code type.
Click to summarize M_CODABAR

Specifies a Codabar code type.
Click to summarize M_CODE39

Specifies a Code 39 code type.
Click to summarize M_CODE93

Specifies a Code 93 code type.
Click to summarize M_CODE128

Specifies a Code 128 code type.
Click to summarize M_COMPOSITECODE

Specifies a composite code type. INFO
Click to summarize M_DATAMATRIX

Specifies a Data Matrix code type. INFO
Click to summarize M_EAN8

Specifies an EAN 8 code type.
Click to summarize M_EAN13

Specifies an EAN 13 code type.
Click to summarize M_EAN14

Specifies an EAN 14 code type.
Click to summarize M_GS1_128

Specifies a GS1-128 code type.
Click to summarize M_GS1_DATABAR

Specifies a GS1 Databar code type.
Click to summarize M_INDUSTRIAL25

Specifies an Industrial 2 of 5 (standard 2 of 5) code type.
Click to summarize M_INTERLEAVED25

Specifies an Interleaved 2 of 5 (ITF-14) code type. INFO
Click to summarize M_MAXICODE

Specifies a Maxicode code type. INFO
Click to summarize M_MICROPDF417

Specifies a MicroPDF417 code type. INFO
Click to summarize M_MICROQRCODE

Specifies a Micro QR code type. INFO
Click to summarize M_PDF417

Specifies a PDF417 code type. INFO
Click to summarize M_PHARMACODE

Specifies a Pharmacode code type.
Click to summarize M_PLANET

Specifies a Planet code type.
Click to summarize M_POSTNET

Specifies a Postnet code type.
Click to summarize M_QRCODE

Specifies a QR code type. INFO
Click to summarize M_TRUNCATED_PDF417

Specifies a Truncated PDF417 code type. INFO
Click to summarize M_UPC_A

Specifies a UPC-A code type.
Click to summarize M_UPC_E

Specifies a UPC-E code type.
Click to summarize M_SUPPORTED_CODE_TYPES_1D +

Inquires all 1D code types supported by the module.

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

Specifies a BC412 code type.
Click to summarize M_CODABAR

Specifies a Codabar code type.
Click to summarize M_CODE39

Specifies a Code 39 code type.
Click to summarize M_CODE93

Specifies a Code 93 code type.
Click to summarize M_CODE128

Specifies a Code 128 code type.
Click to summarize M_EAN8

Specifies an EAN 8 code type.
Click to summarize M_EAN13

Specifies an EAN 13 code type.
Click to summarize M_EAN14

Specifies an EAN 14 code type.
Click to summarize M_GS1_128

Specifies a GS1-128 code type.
Click to summarize M_GS1_DATABAR

Specifies a GS1 Databar code type.
Click to summarize M_INDUSTRIAL25

Specifies an Industrial 2 of 5 (standard 2 of 5) code type.
Click to summarize M_INTERLEAVED25

Specifies an Interleaved 2 of 5 (ITF-14) code type. INFO
Click to summarize M_PHARMACODE

Specifies a Pharmacode code type.
Click to summarize M_UPC_A

Specifies a UPC-A code type.
Click to summarize M_UPC_E

Specifies a UPC-E code type.
Click to summarize M_SUPPORTED_CODE_TYPES_2D +

Inquires all 2D code types supported by the module.

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

Specifies an Aztec code type. INFO
Click to summarize M_DATAMATRIX

Specifies a Data Matrix code type. INFO
Click to summarize M_MAXICODE

Specifies a Maxicode code type. INFO
Click to summarize M_MICROPDF417

Specifies a MicroPDF417 code type. INFO
Click to summarize M_MICROQRCODE

Specifies a Micro QR code type. INFO
Click to summarize M_PDF417

Specifies a PDF417 code type. INFO
Click to summarize M_QRCODE

Specifies a QR code type. INFO
Click to summarize M_TRUNCATED_PDF417

Specifies a Truncated PDF417 code type. INFO
Click to summarize M_SUPPORTED_CODE_TYPES_DETECT +

Inquires all code types supported by McodeDetect().

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

Specifies a BC412 code type. INFO
Click to summarize M_CODABAR

Specifies a Codabar code type. INFO
Click to summarize M_CODE39

Specifies a Code 39 code type. INFO
Click to summarize M_CODE93

Specifies a Code 93 code type. INFO
Click to summarize M_CODE128

Specifies a Code 128 code type. INFO
Click to summarize M_EAN8

Specifies an EAN 8 code type. INFO
Click to summarize M_EAN13

Specifies an EAN 13 code type. INFO
Click to summarize M_EAN14

Specifies an EAN 14 code type. INFO
Click to summarize M_GS1_128

Specifies a GS1-128 code type. INFO
Click to summarize M_INDUSTRIAL25

Specifies an Industrial 2 of 5 (standard 2 of 5) code type. INFO
Click to summarize M_INTERLEAVED25

Specifies an Interleaved 2 of 5 (ITF-14) code type. INFO
Click to summarize M_UPC_A

Specifies a UPC-A code type. INFO
Click to summarize M_UPC_E

Specifies a UPC-E code type. INFO
Click to summarize M_SUPPORTED_CODE_TYPES_POSTAL +

Inquires all postal code types supported by the module.

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

Specifies a 4-state code type.
Click to summarize M_PLANET

Specifies a Planet code type.
Click to summarize M_POSTNET

Specifies a Postnet code type.
Combination value for the values listed in For inquiring about code context or result buffer settings (exceptions might exist).

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

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

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

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

To inquire about the number of code models in a code context, set the InquireType parameter to the following value. In this case, set the ContextOrResultCodeId parameter to a code context.

function map For inquiring about the number of code models in a code context
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_NUMBER_OF_CODE_MODELS +

Inquires the number of code models in the code context.

(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 code models in the code context.

To inquire about general code context settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code context.

Note that besides code type restrictions listed explicitly in the values below, McodeGrade() does not support M_4_STATE, M_PHARMACODE, M_POSTNET, and M_PLANET code types.

Although the settings of all these inquire types affect the results of McodeTrain(), see the description of the inquire types to determine if their corresponding control type can be activated for training; you can also use filters to limit the inquire types in the table to those whose control type can be trained.

function map For inquiring about code context settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_INITIALIZATION_MODE +

Inquires the initialization mode of the code context. 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_TYPICAL_RECOGNITION.
Click to summarize M_IMPROVED_RECOGNITION

Specifies a code context that might provide a more robust McodeRead(), McodeGrade(), or McodeTrain() operation. INFO
Click to summarize M_TYPICAL_RECOGNITION

Specifies a code context that might provide a quicker McodeRead() or McodeGrade() operation.
Click to summarize M_MINIMUM_CONTRAST +

Inquires the minimum possible contrast between the foreground and background in the target image.

This inquire type is only available for 1D codes (excluding Planet and Postnet) when using the M_ADAPTIVE threshold mode. 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 50.
Click to summarize 1 <= Value <= 255

Specifies the minimum contrast. INFO
Click to summarize M_SCANLINE_HEIGHT +

Inquires the scan line height (or thickness).

This inquire type is only available for 1D code types, Micro PDF417, and composite code types. 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 that the scan line height is based on the value of M_SPEED.
Click to summarize Value

Specifies the scan line height, relative to the input coordinate system specified using M_SCANLINE_INPUT_UNITS. INFO
Click to summarize M_SCANLINE_INPUT_UNITS +

Inquires the units with which to interpret the M_SCANLINE_STEP and M_SCANLINE_HEIGHT inquire types.

This inquire type is only available for 1D code types, Micro PDF417, and composite code types. 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 values in pixel units, with respect to the pixel coordinate system.
Click to summarize M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Click to summarize M_SCANLINE_STEP +

Inquires the scan line step (or interval).

This inquire type is only available for 1D code types, Micro PDF417, and composite code types. 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 that the scan line step is based on the value of M_SPEED. INFO
Click to summarize Value

Specifies the scan line step, relative to the input coordinate system specified using M_SCANLINE_INPUT_UNITS. INFO
Click to summarize M_SEARCH_ANGLE_MODE +

Inquires whether the search angular range algorithm for the code context is enabled.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_SEARCH_ANGLE with M_TRAIN. 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_ENABLE.
Click to summarize M_DISABLE

Specifies that the search angular range algorithm is not used.
Click to summarize M_ENABLE

Specifies that the search angular range algorithm is used.
Click to summarize M_SPEED +

Inquires the search speed.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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_HIGH

Specifies a high search speed.
Click to summarize M_LOW

Specifies a low search speed.
Click to summarize M_MEDIUM

Specifies a medium search speed.
Click to summarize M_VERY_HIGH

Specifies a very high search speed.
Click to summarize M_VERY_LOW

Specifies a very low search speed.
Click to summarize M_THRESHOLD_MODE +

Inquires the threshold mode used to internally binarize the source image.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize M_ADAPTIVE

Specifies to use a fast dynamic local threshold. INFO
Click to summarize M_GLOBAL_SEGMENTATION

Specifies to use a global threshold value. INFO
Click to summarize M_GLOBAL_WITH_LOCAL_RESEGMENTATION

Specifies that the source image will be globally thresholded and then the edges in the binarized image are resegmented according to the intensities of the surrounding bars and spaces in the original source image. INFO
Click to summarize M_THRESHOLD_VALUE +

Inquires the threshold value used to internally binarize the source image, depending on the threshold mode.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_THRESHOLD_MODE with M_TRAIN. 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_COMPUTE.
Click to summarize M_AUTO_COMPUTE

Specifies the threshold value automatically.
Click to summarize 0 <= Value <= 255

Specifies the threshold value. INFO
Click to summarize M_TIMEOUT +

Inquires the maximum decoding time for an McodeRead() or McodeGrade() operation, in msec. 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 msec.
Click to summarize M_DISABLE

Specifies that there is no maximum decoding time.
Click to summarize Value >= 0

Specifies the maximum decoding time, in msec.
Click to summarize M_TOTAL_NUMBER +

Inquires the total number of codes to be read in one source image. Note that this number is limited by the maximum number of occurrences of each code model to read or grade (M_NUMBER).

Only 1D code types (excluding GS1 Databar, 4-state, Planet, and Postnet code types) and the 2D Data Matrix code type support searching for multiple occurrences. 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_ALL.
Click to summarize M_ALL

Specifies to read/grade all code occurrences in the source image, up to the maximum number of occurrences to read/grade of each code model (M_NUMBER).
Click to summarize Value > 0

Specifies the maximum number of codes to read/grade in one source image. INFO

To inquire about general code context settings that affect an McodeGrade() operation, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code context.

Note that besides code type restrictions listed explicitly in the values below, McodeGrade() does not support M_4_STATE, M_PHARMACODE, M_POSTNET, and M_PLANET code types.

function map For inquiring about code context settings that affect an McodeGrade() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_ABSOLUTE_APERTURE_SIZE +

Inquires the absolute size (diameter) of the aperture. 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 Value >= 0

Specifies the absolute aperture size, relative to the input coordinate system specified using M_ABSOLUTE_APERTURE_SIZE_INPUT_UNITS.
Click to summarize M_ABSOLUTE_APERTURE_SIZE_INPUT_UNITS +

Inquires the units with which to interpret the M_ABSOLUTE_APERTURE_SIZE inquire type. 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. INFO
Click to summarize M_APERTURE_MODE +

Inquires the way in which the aperture size is determined. 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_RELATIVE.
Click to summarize M_ABSOLUTE

Specifies to use the absolute aperture size, set using M_ABSOLUTE_APERTURE_SIZE.
Click to summarize M_DISABLE

Specifies to disable the aperture. INFO
Click to summarize M_RELATIVE

Specifies to use a relative aperture size, based on the cell size (using M_CELL_SIZE...) and the relative aperture factor (using M_RELATIVE_APERTURE_FACTOR).
Click to summarize M_EXTENDED_AREA_REFLECTANCE_CHECK +

Inquires whether the grading must perform an additional reflectance check over an area containing the code occurrence and its extended area (that is, 20 times the cell size beyond the quiet zone on all sides).

This control type is only used for 2D code types. 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_DISABLE.
Click to summarize M_DISABLE

Specifies to disable the additional reflectance check.
Click to summarize M_ENABLE

Specifies to enable the additional reflectance check. INFO
Click to summarize M_GRADE_QUIET_ZONE +

Inquires whether to include the quiet zone when performing an McodeGrade() operation.

This inquire type is only available for Data Matrix, QR code, and Micro QR code types. 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_ENABLE.
Click to summarize M_DISABLE

Specifies to exclude the quiet zone.
Click to summarize M_ENABLE

Specifies to include the quiet zone.
Click to summarize M_GRADING_STANDARD +

Inquires the grading standard used when performing an McodeGrade() operation. 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_ISO_DPM_GRADING

Specifies an ISO/IEC TR 29158 specification. INFO
Click to summarize M_ISO_GRADING

Specifies an ISO/IEC 15416 or ISO/IEC 15415 specification.
Click to summarize M_SEMI_T10_GRADING

Specifies a Semi T10 specification. INFO
Click to summarize M_INSPECTION_BAND_RATIO +

Inquires the height of the inspection band as a percentage of the average bar height.

This inquire type is only available for 1D code types and 2D cross-row code types. 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 percentage. INFO
Click to summarize 0.0 < Value < 100.0

Specifies the percentage of the average bar height used as the height of the inspection band.
Click to summarize M_MAXIMUM_CALIBRATED_REFLECTANCE +

Inquires the maximum possible grayscale value in the target image. 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 255.
Click to summarize 0 <= Value <= 255

Specifies the maximum calibrated reflectance. INFO
Click to summarize M_MEAN_LIGHT_CALIBRATION +

Inquires the expected mean light (MLcal). This corresponds to the expected mean intensity of the centers of the white elements of the code occurrence.

This value is used during the target grading phase of the ISO/IEC TR 29158:2011 specification.

This inquire type is only available for Aztec, Data Matrix, QR code, and Micro QR code types. SET 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 equal to the setting of M_MAXIMUM_CALIBRATED_REFLECTANCE.
Click to summarize 0 <= Value <= 255

Specifies the mean intensity. INFO
Click to summarize M_MINIMUM_CALIBRATED_REFLECTANCE +

Inquires the minimum possible grayscale value in the target image. 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 0.
Click to summarize 0 <= Value <= 255

Specifies the minimum calibrated reflectance. INFO
Click to summarize M_NUMBER_OF_SCANLINES +

Inquires the number of scan lines inside the inspection band to inspect during the McodeGrade() operation, after the code occurrence has been located.

This inquire type is only available for 1D code types and 2D cross-row code types. 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. INFO
Click to summarize M_ALL

Specifies to use all possible scan lines inside the inspection band.
Click to summarize Value > 0

Specifies the number of scan lines to inspect. INFO
Click to summarize M_PIXEL_SIZE_IN_MM +

Inquires the scale between a pixel and its physical measurement, in millimeters per pixel units. 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

Same as M_UNKNOWN.
Click to summarize M_UNKNOWN

Specifies that the scale between a pixel and its physical measurement is not known, in mm per pixel units.
Click to summarize Value > 0

Specifies the scale between a pixel and its physical measurement, in mm per pixel units.
Click to summarize M_REFLECTANCE_CALIBRATION +

Inquires the expected reflectance value (Rcal). This value is used during the target grading phase of the ISO/IEC TR 29158:2011 specification.

This inquire type is only available for Aztec, Data Matrix, QR code, and Micro QR code types. SET 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 equal to the setting of M_MAXIMUM_CALIBRATED_REFLECTANCE.
Click to summarize 0 <= Value <= 255

Specifies the reflectance value. INFO
Click to summarize M_RELATIVE_APERTURE_FACTOR +

Inquires the relative aperture factor. 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

Same as M_AUTO.
Click to summarize M_AUTO

Specifies that the aperture factor is chosen according to the ISO/IEC 15416 specification for all supported code types except 2D matrix code types; for the latter, the aperture factor is chosen according to the ISO/IEC 15415 or ISO/IEC TR 29158 specification (depends on M_GRADING_STANDARD). INFO
Click to summarize 0 <= Value <= 2

Specifies the aperture factor.
Click to summarize M_SYSTEM_RESPONSE_CALIBRATION +

Inquires the System Response value derived during the reflectance calibration phase (SRcal) of the ISO/IEC TR 29158:2011 specification.

This inquire type is only available for Aztec, Data Matrix, QR code, and Micro QR code types. 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 System Response value for the reference code.
Click to summarize M_SYSTEM_RESPONSE_TARGET +

Inquires the System Response value derived during the target grading phase (SRtarget) of the ISO/IEC TR 29158:2011 specification.

This inquire type is only available for Aztec, Data Matrix, QR code, and Micro QR code types. 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 System Response value for the target code.

To inquire about general code context settings that affect an McodeTrain() operation, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code context.

function map For inquiring about code context settings that affect an McodeTrain() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_TRAIN_TIMEOUT +

Inquires the maximum training time for an McodeTrain() operation. 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies to disable the timeout.
Click to summarize Value >= 0

Specifies the timeout limit, in msec.

To inquire about the code type of a code model, set the InquireType parameter to the following value. In this case, set the ContextOrResultCodeId parameter to a code model.

function map For inquiring about a code model's code type
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_CODE_TYPE +

Inquires the code type of the specified model. 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_4_STATE

Specifies a 4-state code type.
Click to summarize M_AZTEC

Specifies an Aztec code type. INFO
Click to summarize M_BC412

Specifies a BC412 code type.
Click to summarize M_CODABAR

Specifies a Codabar code type.
Click to summarize M_CODE39

Specifies a Code 39 code type.
Click to summarize M_CODE93

Specifies a Code 93 code type.
Click to summarize M_CODE128

Specifies a Code 128 code type.
Click to summarize M_COMPOSITECODE

Specifies a composite code type. INFO
Click to summarize M_DATAMATRIX

Specifies a Data Matrix code type. INFO
Click to summarize M_EAN8

Specifies an EAN 8 code type.
Click to summarize M_EAN13

Specifies an EAN 13 code type.
Click to summarize M_EAN14

Specifies an EAN 14 code type.
Click to summarize M_GS1_128

Specifies a GS1-128 code type.
Click to summarize M_GS1_DATABAR

Specifies a GS1 Databar code type.
Click to summarize M_INDUSTRIAL25

Specifies an Industrial 2 of 5 (standard 2 of 5) code type.
Click to summarize M_INTERLEAVED25

Specifies an Interleaved 2 of 5 (ITF-14) code type. INFO
Click to summarize M_MAXICODE

Specifies a Maxicode code type. INFO
Click to summarize M_MICROPDF417

Specifies a MicroPDF417 code type. INFO
Click to summarize M_MICROQRCODE

Specifies a Micro QR code type. INFO
Click to summarize M_PDF417

Specifies a PDF417 code type. INFO
Click to summarize M_PHARMACODE

Specifies a Pharmacode code type.
Click to summarize M_PLANET

Specifies a Planet code type.
Click to summarize M_POSTNET

Specifies a Postnet code type.
Click to summarize M_QRCODE

Specifies a QR code type. INFO
Click to summarize M_TRUNCATED_PDF417

Specifies a Truncated PDF417 code type. INFO
Click to summarize M_UPC_A

Specifies a UPC-A code type.
Click to summarize M_UPC_E

Specifies a UPC-E code type.

To inquire about code model settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code model.

Note that besides code type restrictions listed explicitly in the values below, McodeGrade() does not support M_4_STATE, M_PHARMACODE, M_POSTNET, and M_PLANET code types.

Although the settings of all these inquire types affect the results of McodeTrain(), see the description of the inquire types to determine if their corresponding control type can be activated for training; you can also use filters to limit the inquire types in the table to those whose control type can be trained.

function map For inquiring about code model settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_BEARER_BAR +

Inquires whether bearer bars run along the top and bottom of the code occurrences to read (such as, the edge of a sticker).

This value is available only for 1D code types. 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_ABSENT.
Click to summarize M_ABSENT

Specifies that no bearer bars are above and below the code.
Click to summarize M_PRESENT

Specifies that there are bearer bars above and below the code.
Click to summarize M_CELL_NUMBER_X_MAX +

Inquires the maximum number of cells for which to search in the X-direction.

This inquire type is only available for 2D code types.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_CELL_NUMBER_X with M_TRAIN. 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_ANY.
Click to summarize M_ANY

Specifies to search for code occurrences with any number of cells.
Click to summarize Value > 0

Specifies the maximum number of cells for which to search. INFO
Click to summarize M_CELL_NUMBER_X_MIN +

Inquires the minimum number of cells for which to search in the X-direction.

This inquire type is only available for 2D code types.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_CELL_NUMBER_X with M_TRAIN. 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_ANY.
Click to summarize M_ANY

Specifies to search for code occurrences with any number of cells.
Click to summarize Value > 0

Specifies the minimum number of cells for which to search. INFO
Click to summarize M_CELL_NUMBER_Y_MAX +

Inquires the maximum number of cells for which to search in the Y-direction.

This inquire type is only available for 2D code types.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_CELL_NUMBER_Y with M_TRAIN. 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_ANY.
Click to summarize M_ANY

Specifies to search for code occurrences with any number of cells.
Click to summarize Value > 0

Specifies the maximum number of cells for which to search. INFO
Click to summarize M_CELL_NUMBER_Y_MIN +

Inquires the minimum number of cells for which to search in the Y-direction.

This inquire type is only available for 2D code types.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_CELL_NUMBER_Y with M_TRAIN. 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_ANY.
Click to summarize M_ANY

Specifies to search for code occurrences with any number of cells.
Click to summarize Value > 0

Specifies the minimum number of cells for which to search. INFO
Click to summarize M_CELL_SIZE_MAX +

Inquires the maximum cell size. 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 to select an appropriate size, automatically.
Click to summarize Value

Specifies the maximum cell size, relative to the input coordinate system specified using M_CELL_SIZE_INPUT_UNITS. INFO
Click to summarize M_CELL_SIZE_MIN +

Inquires the minimum cell size. 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 cell size, in pixels. INFO
Click to summarize Value

Specifies the minimum cell size, relative to the input coordinate system specified using M_CELL_SIZE_INPUT_UNITS. INFO
Click to summarize M_CHECK_FINDER_PATTERN +

Inquires whether checking for a false Data Matrix pattern is enabled.

This inquire type is only available for Data Matrix code types. 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_DISABLE.
Click to summarize M_DISABLE

Specifies that the Code module will not check for false Data Matrix code types.
Click to summarize M_ENABLE

Specifies that the Code module will check for false Data Matrix code types.
Click to summarize M_CHECK_QUIET_ZONE +

Inquires whether the presence of the quiet zone is necessary for a successful McodeRead() or McodeGrade() operation of this code type.

Note that the specifications of a code's quiet zone are dependent upon the code type. 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_ENABLE.
Click to summarize M_DISABLE

Specifies that a quiet zone is not necessary. INFO
Click to summarize M_ENABLE

Specifies that a quiet zone is necessary.
Click to summarize M_CODE_FLIP +

Inquires whether code occurrences need to be flipped or read in the opposite direction to be read properly.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize M_ANY

Allows MIL to decide whether a code occurrence needs to be flipped or read in the opposite direction to be read properly.
Click to summarize M_FLIP

Specifies that code occurrences need to be flipped or read in the opposite direction to be read properly. INFO
Click to summarize M_NO_FLIP

Specifies that code occurrences don't need to be flipped or read in the opposite direction. INFO
Click to summarize M_CODE_SEARCH_MODE +

Inquires the behavior of the decoding algorithm.

Note that only 1D code types (excluding M_4_STATE, M_GS1_DATABAR, M_PLANET, and M_POSTNET) support the M_BEST control value setting. 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. INFO
Click to summarize M_BEST

Specifies to search and return the best quality code occurrences.
Click to summarize M_FAST

Specifies to search and return the first code occurrences decoded.
Click to summarize M_DATAMATRIX_SHAPE +

Inquires the shape of the Data Matrix code.

This inquire type is only available for the Data Matrix code type.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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_ANY.
Click to summarize M_ANY

Specifies that the Data Matrix code type can be any shape.
Click to summarize M_RECTANGLE

Specifies that the Data Matrix code has a rectangular shape. INFO
Click to summarize M_SQUARE

Specifies that the Data Matrix code has a square shape. INFO
Click to summarize M_DECODE_ALGORITHM +

Inquires the decoding algorithm used to read the code occurrences.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize M_CODE_DEFORMED

Specifies to use the algorithm to decode deformed code occurrences. INFO
Click to summarize M_CODE_NOT_DEFORMED

Specifies to use the algorithm to decode non-deformed code occurrences.
Click to summarize M_DOT_SPACING_INPUT_UNITS +

Inquires the units with which to interpret the M_DOT_SPACING_MAX and M_DOT_SPACING_MIN inquire types.

This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_MAXICODE, M_QRCODE, and M_MICROQRCODE code types. 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. INFO
Click to summarize M_DOT_SPACING_MAX +

Inquires the maximum distance between 2 dots in a matrix code type composed of dots.

This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_MAXICODE, M_QRCODE, and M_MICROQRCODE code types.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize -256 <= Value <= 256

Specifies the distance, relative to the input coordinate system specified using M_DOT_SPACING_INPUT_UNITS. INFO
Click to summarize M_DOT_SPACING_MIN +

Inquires the minimum distance between 2 dots in a matrix code type composed of dots.

This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_MAXICODE, M_QRCODE, and M_MICROQRCODE code types.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize -256 <= Value <= 256

Specifies the distance, relative to the input coordinate system specified using M_DOT_SPACING_INPUT_UNITS. INFO
Click to summarize M_ECC_CORRECTED_NUMBER +

Inquires whether McodeRead() or McodeGrade() are forced to perform a more robust operation to minimize the number of errors to correct.

This inquire type is only available for PDF417 and Truncated PDF417 code types. 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_DISABLE.
Click to summarize M_DISABLE

Specifies not to perform a more robust operation.
Click to summarize M_ENABLE

Specifies to perform a more robust operation.
Click to summarize M_FINDER_PATTERN_EXHAUSTIVE_SEARCH +

Inquires whether to search for the L-shaped finder pattern (the gray boxed area in the following image) to help localize the Data Matrix code.

This inquire type is only available for Data Matrix code types. 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_DISABLE.
Click to summarize M_DISABLE

Specifies to not perform an exhaustive search.
Click to summarize M_ENABLE

Specifies to perform an exhaustive search.
Click to summarize M_FINDER_PATTERN_INPUT_UNITS +

Inquires the units with which to interpret the M_FINDER_PATTERN_EXHAUSTIVE_SEARCH and M_FINDER_PATTERN_MINIMUM_LENGTH inquire types.

This inquire type is only available for Data Matrix code types. 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 values in pixel units, with respect to the pixel coordinate system.
Click to summarize M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Click to summarize M_FINDER_PATTERN_MAX_GAP +

Inquires the maximum tolerable gap in the finder pattern of a Data Matrix code.

This inquire type is only available for Data Matrix code types. 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

Same as M_AUTO.
Click to summarize M_AUTO

Specifies that the maximum tolerable gap in the finder pattern is 6 times the minimum cell size specified using M_CELL_SIZE_MIN.
Click to summarize Value

Specifies the maximum gap allowed, in input units specified using M_FINDER_PATTERN_INPUT_UNITS.
Click to summarize M_FINDER_PATTERN_MINIMUM_LENGTH +

Inquires the shortest acceptable length of either "arm" of the finder pattern of a Data Matrix code occurrence.

This inquire type is only available for Data Matrix code types. 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

Same as M_AUTO.
Click to summarize M_AUTO

Specifies that the minimum acceptable finder pattern "arm" length is 6 times the minimum cell size specified using M_CELL_SIZE_MIN.
Click to summarize Value

The minimum acceptable finder pattern "arm" length, in input units specified using M_FINDER_PATTERN_INPUT_UNITS.
Click to summarize M_NUMBER +

Inquires the maximum number of codes to be read for the specified code model. This number is also limited by M_TOTAL_NUMBER.

Only 1D code types (excluding GS1 Databar, 4-state, Planet, and Postnet code types) and the 2D Data Matrix code type support searching for multiple occurrences. 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 1.
Click to summarize M_ALL

Specifies that all code model occurrences are read/graded up to the maximum number limited by M_TOTAL_NUMBER.
Click to summarize Value >= 0

Specifies the maximum number of code occurrences of the specified code model to read or grade. INFO
Click to summarize M_POSITION_ACCURACY +

Inquires the accuracy of positional results. Accuracy depends on the settings of the code context and its models. 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. INFO
Click to summarize M_HIGH

Specifies to report the positional results of the code operation with high accuracy.
Click to summarize M_LOW

Specifies to report the positional results of the code operation with low accuracy.
Click to summarize M_SEARCH_ANGLE +

Inquires the nominal search angle.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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 degrees.
Click to summarize M_ACCORDING_TO_REGION

Specifies that the nominal angle is set to the angle of the target image's ROI (MbufSetRegion()); recall that for McodeGrade() and McodeRead(), the ROI must be rectangular. INFO
Click to summarize 0.0 <= Value <= 360.0

Specifies the nominal angle, in degrees, relative to the input coordinate system specified using M_SEARCH_ANGLE_INPUT_UNITS. INFO
Click to summarize M_SEARCH_ANGLE_DELTA_NEG +

Inquires the negative angular range of the search.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_SEARCH_ANGLE with M_TRAIN. 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. INFO
Click to summarize 0.0 <= Value <= 180.0

Specifies a negative angular range, in degrees, relative to the nominal angle set by M_SEARCH_ANGLE. INFO
Click to summarize M_SEARCH_ANGLE_DELTA_POS +

Inquires the positive angular range of the search.

Note that the corresponding control type can be automatically activated for training; to inquire if it has been activated for training, use M_SEARCH_ANGLE with M_TRAIN. 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. INFO
Click to summarize 0.0 <= Value <= 180.0

Specifies a positive angular range, in degrees, relative to the nominal angle set by M_SEARCH_ANGLE. INFO
Click to summarize M_SEARCH_ANGLE_INPUT_UNITS +

Inquires the units with which to interpret the M_SEARCH_ANGLE inquire type. 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. INFO
Click to summarize M_SEARCH_ANGLE_STEP +

Inquires the angle increment/decrement used when searching for a 1D code through an angular range.

This inquire type is only available for 1D code types. 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

Same as M_DISABLE.
Click to summarize M_DISABLE

Specifies that no explicit increment/decrement is used. INFO
Click to summarize 0.1 <= Value <= 180.0

Specifies the explicit angle increment/decrement, in degrees.
Click to summarize M_STRING_SIZE_MAX +

Inquires the maximum size (number of characters) of the string encoded in a code occurrence. 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_ANY.
Click to summarize M_ANY

Specifies that there is no maximum string size.
Click to summarize 0 <= Value <= 65535

Specifies the maximum string size. INFO
Click to summarize M_STRING_SIZE_MIN +

Inquires the minimum size (number of characters) of the string encoded in the code. 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_ANY.
Click to summarize M_ANY

Specifies that there is no minimum string size.
Click to summarize 0 <= Value <= 65535

Specifies the minimum string size. INFO
Click to summarize M_SUB_TYPE +

Inquires the particular code sub-types for which to search.

This value is available only for M_GS1_DATABAR and M_COMPOSITECODE code types. 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_ANY.
Click to summarize M_ANY

Specifies to search for all of the code sub-types that can be specified for M_SUB_TYPE.
Click to summarize M_EAN8

Specifies that the EAN 8 code sub-type is enabled. INFO
Click to summarize M_EAN13

Specifies that the EAN 13 code sub-type is enabled. INFO
Click to summarize M_GS1_128

Specifies that the GS1-128 code sub-type is enabled. INFO
Click to summarize M_GS1_DATABAR_EXPANDED

Specifies that the GS1 Databar Expanded code sub-type is enabled.
Click to summarize M_GS1_DATABAR_EXPANDED_STACKED

Specifies that the GS1 Databar Expanded Stacked code sub-type is enabled.
Click to summarize M_GS1_DATABAR_LIMITED

Specifies that the GS1 Databar Limited code sub-type is enabled.
Click to summarize M_GS1_DATABAR_OMNI

Specifies that the GS1 Databar Omnidirectional code sub-type is enabled.
Click to summarize M_GS1_DATABAR_STACKED

Specifies that the GS1 Databar Stacked code sub-type is enabled.
Click to summarize M_GS1_DATABAR_STACKED_OMNI

Specifies that the GS1 Databar Stacked Omnidirectional code sub-type is enabled.
Click to summarize M_GS1_DATABAR_TRUNCATED

Specifies that the GS1 Databar Truncated code sub-type is enabled.
Click to summarize M_UPC_A

Specifies that the UPC-A code sub-type is enabled. INFO
Click to summarize M_UPC_E

Specifies that the UPC-E code sub-type is enabled. INFO
Click to summarize M_USE_PRESEARCH +

Inquires whether the localization operation is performed prior to the decoding step of an operation.

This inquire type is only available for 2D code types.

Note that the corresponding control type can be trained; to inquire if it has been activated for training, combine this inquire type with M_TRAIN. 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. INFO
Click to summarize M_DISABLE

Specifies that the operation is not performed.
Click to summarize M_FINDER_PATTERN_BASE

Specifies that the localization operation is only performed on the base pattern of the Data Matrix code (an "L" starting at the top-most left corner, and ending on the bottom-most right corner of the code). INFO
Click to summarize M_STAT_BASE

Specifies to localize the code within the image with the statistical characteristics of a 2D bar code (for example, local variance and the presence of a lot of edges). INFO

To inquire about code model settings that affect an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation, the InquireType parameter can be set to one of the following values. In this case, set the ContextOrResultCodeId parameter to a code model.

Note that besides code type restrictions listed explicitly in the values below, McodeGrade() does not support M_4_STATE, M_PHARMACODE, M_POSTNET, and M_PLANET code types.

Although the settings of all these inquire types affect the results of McodeTrain(), see the description of the inquire types to determine if their corresponding control type can be activated for training; you can also use filters to limit the inquire types in the table to those whose control type can be trained.

function map For inquiring about code model settings that affect an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_CELL_NUMBER_X +

Inquires the number of cells to be used in the X-direction.

This inquire type is only available for 2D code types. 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_ANY.
Click to summarize M_ANY

Specifies to search for a code with any number of cells, when performing an McodeRead() or McodeGrade() operation. INFO
Click to summarize Value > 0

Specifies the number of cells. INFO
Click to summarize M_CELL_NUMBER_Y +

Inquires the number of cells to be used in the Y-direction.

This inquire type is only available for 2D code types. 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_ANY.
Click to summarize M_ANY

Specifies to search for a code with any number of cells, when performing an McodeRead() or McodeGrade() operation. INFO
Click to summarize Value > 0

Specifies the number of cells. INFO
Click to summarize M_CELL_SIZE_INPUT_UNITS +

Inquires the units with which to interpret the M_CELL_SIZE_MAX and M_CELL_SIZE_MIN inquire types. 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 values in pixel units, with respect to the pixel coordinate system.
Click to summarize M_WORLD

Specifies to interpret the values in world units, with respect to the relative coordinate system. INFO
Click to summarize M_ENCODING +

Inquires the type of encoding scheme. 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 to use the default encoding scheme for the code type. INFO
Click to summarize M_ANY

Specifies any type of encoding scheme. INFO
Click to summarize M_ENC_ALPHA

Specifies an encoding scheme that supports uppercase alphabetical characters, along with the space. INFO
Click to summarize M_ENC_ALPHANUM

Specifies an encoding scheme that supports alphanumeric characters, as well as the space. INFO
Click to summarize M_ENC_ALPHANUM_PUNC

Specifies a similar encoding scheme to M_ENC_ALPHANUM, except it also supports the following characters: (,), (-), (/) and (. INFO
Click to summarize M_ENC_ASCII

Specifies an encoding scheme that supports ASCII characters. INFO
Click to summarize M_ENC_AUSTRALIA_MAIL_C

Specifies an encoding scheme for a 4-state format used with the C encoding table by the Australian Mail service. INFO
Click to summarize M_ENC_AUSTRALIA_MAIL_N

Specifies an encoding scheme for a 4-state format used with the N encoding table by the Australian Mail service. INFO
Click to summarize M_ENC_AUSTRALIA_MAIL_RAW

Specifies an encoding scheme for a 4-state format used by the Australian Mail service. INFO
Click to summarize M_ENC_AZTEC_COMPACT

Specifies an encoding scheme for a compact Aztec code. INFO
Click to summarize M_ENC_AZTEC_FULL_RANGE

Specifies an encoding scheme for a full-range (not compact) Aztec code. INFO
Click to summarize M_ENC_AZTEC_RUNE

Specifies an encoding scheme for an Aztec rune (the smallest version of an Aztec code). INFO
Click to summarize M_ENC_EAN8

Specifies an encoding scheme for a composite code whose 1D portion uses an EAN 8 format and whose 2D portion uses a MicroPDF417 format. INFO
Click to summarize M_ENC_EAN8_ADDON

Specifies an encoding scheme for an EAN 8 format with a supplemental 2 or 5 digit add-on. INFO
Click to summarize M_ENC_EAN13

Specifies an encoding scheme for a composite code whose 1D portion uses an EAN 13 format and whose 2D portion uses a MicroPDF417 format. INFO
Click to summarize M_ENC_EAN13_ADDON

Specifies an encoding scheme for an EAN 13 format with a supplemental 2 or 5 digit add-on. INFO
Click to summarize M_ENC_GS1_128_MICROPDF417

Specifies an encoding scheme for a composite code whose 1D portion uses a GS1 128 format and whose 2D portion uses a MicroPDF417 format. INFO
Click to summarize M_ENC_GS1_128_PDF417

Specifies an encoding scheme for a composite code whose 1D portion uses a GS1 128 format and whose 2D portion uses a PDF417 format. INFO
Click to summarize M_ENC_GS1_DATABAR_EXPANDED

Specifies an encoding scheme that uses a GS1 Databar format. INFO
Click to summarize M_ENC_GS1_DATABAR_EXPANDED_STACKED

Specifies an encoding scheme that uses a GS1 Databar Expanded Stacked format. INFO
Click to summarize M_ENC_GS1_DATABAR_LIMITED

Specifies an encoding scheme that uses a GS1 Databar Limited format. INFO
Click to summarize M_ENC_GS1_DATABAR_OMNI

Specifies an encoding scheme that uses a GS1 Databar format. INFO
Click to summarize M_ENC_GS1_DATABAR_STACKED

Specifies an encoding scheme that uses a GS1 Databar Stacked format. INFO
Click to summarize M_ENC_GS1_DATABAR_STACKED_OMNI

Specifies an encoding scheme that uses a GS1 Databar Stacked Omnidirectional format. INFO
Click to summarize M_ENC_GS1_DATABAR_TRUNCATED

Specifies an encoding scheme that uses a GS1 Databar Truncated format. INFO
Click to summarize M_ENC_ISO8

Specifies a similar encoding scheme as M_ENC_ASCII, but supports the extended ASCII character set. INFO
Click to summarize M_ENC_KOREA_MAIL

Specifies an encoding scheme for a 4-state format used by the Korean Mail service. INFO
Click to summarize M_ENC_MODE2

Specifies an encoding scheme that requires a Structured Carrier Message. INFO
Click to summarize M_ENC_MODE3

Specifies an encoding scheme that requires a Structured Carrier Message. INFO
Click to summarize M_ENC_MODE4

Specifies an encoding scheme that requires a Free Format Message. INFO
Click to summarize M_ENC_MODE5

Specifies an encoding scheme that requires a Free Format Message. INFO
Click to summarize M_ENC_MODE6

Specifies an encoding scheme that requires a Free Format Message. INFO
Click to summarize M_ENC_NUM

Specifies an encoding scheme that only supports numbers. INFO
Click to summarize M_ENC_QRCODE_MODEL1

Specifies an encoding scheme that uses an older version of the QR code format. INFO
Click to summarize M_ENC_QRCODE_MODEL2

Specifies an encoding scheme that uses a newer version of the QR code format. INFO
Click to summarize M_ENC_STANDARD

Specifies different types of encoding schemes, depending on what code type is used. INFO
Click to summarize M_ENC_UK_MAIL

Specifies an encoding scheme for a 4-state format used by the UK Mail service. INFO
Click to summarize M_ENC_UPCA

Specifies an encoding scheme for a composite code whose 1D portion uses an UPC-A format and whose 2D portion uses a MicroPDF417 format. INFO
Click to summarize M_ENC_UPCA_ADDON

Specifies an encoding scheme for an UPC-A format with a supplemental 2 or 5 digit add-on. INFO
Click to summarize M_ENC_UPCE

Specifies an encoding scheme for a composite code whose 1D portion uses an UPC-E format and whose 2D portion uses a MicroPDF417 format. INFO
Click to summarize M_ENC_UPCE_ADDON

Specifies an encoding scheme for an UPC-E format with a supplemental 2 or 5 digit add-on. INFO
Click to summarize M_ENC_US_MAIL

Specifies an encoding scheme for a 4-state format used by the US Mail service. INFO
Click to summarize 5 <= Value <= 95

Specifies the minimum amount of the symbol that contains error correction information, as a percentage. INFO
Click to summarize M_ERROR_CORRECTION +

Inquires the type of error correction. 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 to use the default error correction scheme for the code type. INFO
Click to summarize M_ANY

Specifies that the error correction type for McodeRead() and McodeGrade() operations is detected automatically. INFO
Click to summarize M_ECC_4STATE

Specifies to use the Reed-Solomon-based algorithm or a check digit type of error correction scheme, depending on the specification of the encoding. INFO
Click to summarize M_ECC_200

Specifies to use a Reed-Solomon-based algorithm as an error correction scheme. INFO
Click to summarize M_ECC_CHECK_DIGIT

Specifies to use an additional digit to check whether there is an error or not. INFO
Click to summarize M_ECC_COMPOSITE

Specifies to use the default error correction scheme for the 1D and 2D portions of the composite code. INFO
Click to summarize M_ECC_H

Specifies to use the highest-level error correction scheme. INFO
Click to summarize M_ECC_L

Specifies to use the lowest-level error correction scheme. INFO
Click to summarize M_ECC_M

Specifies to use a medium-low level error correction scheme. INFO
Click to summarize M_ECC_NONE

Specifies no error correction. INFO
Click to summarize M_ECC_Q

Specifies to use a medium-high level error correction scheme. INFO
Click to summarize M_ECC_REED_SOLOMON

Specifies to use a Reed-Solomon type of error correction scheme. INFO
Click to summarize M_ECC_REED_SOLOMON_n

Specifies to use a Reed-Solomon type of error correction scheme. INFO
Click to summarize 5 <= Value <= 95

Specifies the minimum percentage of the symbol that contains error correction information. INFO
Click to summarize M_FOREGROUND_VALUE +

Inquires the foreground color of the code. 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. INFO
Click to summarize M_FOREGROUND_ANY

Specifies the foreground color as black or white. INFO
Click to summarize M_FOREGROUND_BLACK

Specifies that the foreground color is black.
Click to summarize M_FOREGROUND_WHITE

Specifies that the foreground color is white.
Combination value for M_CELL_NUMBER_X; M_CELL_NUMBER_Y; M_CELL_SIZE_MAX; M_CELL_SIZE_MIN; M_CODE_FLIP; M_DATAMATRIX_SHAPE; M_DECODE_ALGORITHM; M_DOT_SPACING_MAX; M_DOT_SPACING_MIN; M_ENCODING; M_ERROR_CORRECTION; M_FOREGROUND_VALUE; M_SEARCH_ANGLE; M_SPEED; M_THRESHOLD_MODE; M_USE_PRESEARCH.

You can add the following value to the above-mentioned values to determine whether the corresponding control type is activated for training.

function map For inquiring whether the corresponding control type is activated for training
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_TRAIN +

Inquires whether the corresponding control type is activated for training.

You can establish the default activation setting of the corresponding control type, regardless of its current activation setting, using M_TRAIN + M_DEFAULT.

(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 activation; the default activation depends on the control type and code model type. For a given trainable control type, if an unsupported code model is included in the training, the default value will be M_DISABLE, otherwise it will be M_ENABLE.

(summarize)
Click to summarize M_DISABLE

Specifies that the control type has not been activated for training.
Click to summarize M_ENABLE

Specifies that the control type has been activated for training.

To inquire about code model settings that affect an McodeGrade() operation, set the InquireType parameter to one of the following values. In this case, the ContextOrResultCodeId parameter must be set to the identifier of a code model.

function map For inquiring about code model settings that affect an McodeGrade() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_GRADING_STANDARD_EDITION +

Inquires the grading standard edition used when performing an McodeGrade() operation. 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_ISO_15415_2011_15416_2000

Specifies the ISO/IEC 15415:2011 and ISO/IEC 15416:2000 specifications. INFO
Click to summarize M_ISO_15415_2011_15416_2016

Specifies the ISO/IEC 15415:2011 and ISO/IEC 15416:2016 specifications. INFO
Click to summarize M_ISO_15416_2000

Specifies the ISO/IEC 15416:2000 specification. INFO
Click to summarize M_ISO_15416_2016

Specifies the ISO/IEC 15416:2016 specification. INFO
Click to summarize M_ISO_29158_2011

Specifies the ISO/IEC 29158:2011 specification. INFO
Click to summarize M_SEMI_T10_0701

Specifies the Semi T10-0701 specification. INFO

To inquire about code model settings that affect an McodeWrite() operation, set the InquireType parameter to one of the following values. In this case, the ContextOrResultCodeId parameter must be set to the identifier of a code model.

Note that you cannot set ContextOrResultCodeId to the identifier of a code context when using the following inquire types.

function map For inquiring about code model settings that affect an McodeWrite() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_CELL_SIZE_MODE +

Inquires how to establish the cell size to use when performing an McodeWrite() operation. 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 use the largest possible cell size such that the code will be resized as to just fit into the target image of the operation.
Click to summarize M_USER_DEFINED

Specifies that the cell size corresponds to the value of M_CELL_SIZE_VALUE.
Click to summarize M_CELL_SIZE_VALUE +

Inquires the cell size to use when performing an McodeWrite() operation and M_CELL_SIZE_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. INFO
Click to summarize Value > 0.0

Specifies the cell size. INFO
Click to summarize M_DOT_SHAPE +

Inquires the shape in which to draw cells when performing an McodeWrite() operation. 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_SQUARE.
Click to summarize M_CIRCLE

Specifies that the code will be drawn with circular cells. INFO
Click to summarize M_SQUARE

Specifies that the code will be drawn with square cells. INFO
Click to summarize M_DOT_SIZE +

Inquires the size of the dot (or square) in which to draw cells when performing an McodeWrite() operation. 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. INFO
Click to summarize Value > 0.0

Specifies the size of the dot or square. INFO

To inquire about code result buffer settings dealing with an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation, set the InquireType parameter to one of the following values.

function map For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_RESULT_OUTPUT_UNITS +

Inquires the units with which to interpret the results. 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_ACCORDING_TO_CALIBRATION.
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

To inquire about code result buffer settings dealing with an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation, set the InquireType parameter to one of the following values.

function map For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation
Click to summarize
InquireType		 Description
UserVarPtr
- Possible values returned
Click to summarize M_STRING_FORMAT +

Inquires the format in which to return the string, retrieved using McodeGetResult() with M_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_AUTO_FORMAT.
Click to summarize M_AUTO_FORMAT

Specifies that the string is returned in the string format associated with the code type. INFO
Click to summarize M_GS1_HUMAN_READABLE

Specifies that the string is returned in a format that is human-readable. INFO
Click to summarize M_JAPANESE
[This is only applicable to Windows]

Specifies that the string is returned in the Japanese (Windows-932) encoding. INFO
Click to summarize M_KOREAN
[This is only applicable to Windows]

Specifies that the string is returned in the Korean (Windows-949) encoding. INFO
Click to summarize M_LATIN
[This is only applicable to Windows]

Specifies that the returned string uses Latin (Windows-1252) encoding. INFO
Click to summarize M_RAW_DATA

Specifies that the string is returned in a raw data format. INFO
Click to summarize M_SIMPLIFIED_CHINESE
[This is only applicable to Windows]

Specifies that the returned string uses Simplified Chinese (Windows-936) encoding. INFO
Click to summarize M_UPCE_COMPRESSED

Specifies that the returned string is in the UPCE compressed string format. INFO
Click to summarize M_UTF8

Specifies that the returned string is in the UTF-8 string format. INFO
Combination value for the values listed in all the parameter association tables except For inquiring about a code model's code type.

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

function map For inquiring whether 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_NULL

Specifies that the inquire type is not supported.
Click to summarize Value != 0

Specifies that the inquire type is supported.
Combination value for the values listed in For inquiring about code context settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation; the values listed in For inquiring about code context settings that affect an McodeGrade() operation; the values listed in For inquiring about code context settings that affect an McodeTrain() operation; the values listed in For inquiring about code model settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation; the values listed in For inquiring about code model settings that affect an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation; the values listed in For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation; the values listed in For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation; and for the following value: M_TRAIN.

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.

function map For inquiring about the default value of an inquire type
Click to summarizeCombination value Description
Click to summarize M_DEFAULT

Inquires the default value of the specified inquire type.
Combination values for the values listed in For inquiring about code context or result buffer settings; the values listed in For inquiring about the number of code models in a code context; the values listed in For inquiring about code context settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation; the values listed in For inquiring about code context settings that affect an McodeGrade() operation; the values listed in For inquiring about code context settings that affect an McodeTrain() operation; the values listed in For inquiring about a code model's code type; the values listed in For inquiring about code model settings that affect an McodeRead(), McodeGrade(), or McodeTrain() operation; the values listed in For inquiring about code model settings that affect an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation; the values listed in For inquiring about code model settings that affect an McodeGrade() operation; the values listed in For inquiring about code model settings that affect an McodeWrite() operation; the values listed in For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation; the values listed in For inquiring about result buffer settings dealing with an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation; and for the following value: M_TRAIN.

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

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

function map For specifying the data type
Click to summarizeInquireType Description
UserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested data 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  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_TYPE_MIL_ID

Casts the requested data to a MIL_ID.

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

Casts the requested data 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  |  array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ] MORE
Click to summarize M_TYPE_MIL_INT32

Casts the requested data 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  |  array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ] MORE
Click to summarize M_TYPE_MIL_INT64

Casts the requested data 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  |  array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ] MORE
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; milcode.lib.
DLL Requires mil.dll; milcode.dll.
OWNER SYSTEM DEFAULT HOST SUPPORTED CODE TYPES 4 STATE AZTEC BC412 CODABAR CODE39 CODE93 CODE128 COMPOSITECODE DATAMATRIX EAN8 EAN13 EAN14 GS1 128 GS1 DATABAR INDUSTRIAL25 INTERLEAVED25 MAXICODE MICROPDF417 MICROQRCODE PDF417 PHARMACODE PLANET POSTNET QRCODE TRUNCATED PDF417 UPC A UPC E SUPPORTED CODE TYPES 1D BC412 CODABAR CODE39 CODE93 CODE128 EAN8 EAN13 EAN14 GS1 128 GS1 DATABAR INDUSTRIAL25 INTERLEAVED25 PHARMACODE UPC A UPC E SUPPORTED CODE TYPES 2D AZTEC DATAMATRIX MAXICODE MICROPDF417 MICROQRCODE PDF417 QRCODE TRUNCATED PDF417 SUPPORTED CODE TYPES DETECT BC412 CODABAR CODE39 CODE93 CODE128 EAN8 EAN13 EAN14 GS1 128 INDUSTRIAL25 INTERLEAVED25 UPC A UPC E SUPPORTED CODE TYPES POSTAL 4 STATE PLANET POSTNET NB ELEMENTS NUMBER OF CODE MODELS INITIALIZATION MODE DEFAULT IMPROVED RECOGNITION TYPICAL RECOGNITION MINIMUM CONTRAST DEFAULT SCANLINE HEIGHT DEFAULT SCANLINE INPUT UNITS DEFAULT PIXEL WORLD SCANLINE STEP DEFAULT SEARCH ANGLE MODE DEFAULT DISABLE ENABLE SPEED HIGH LOW MEDIUM VERY HIGH VERY LOW THRESHOLD MODE DEFAULT ADAPTIVE GLOBAL SEGMENTATION GLOBAL WITH LOCAL RESEGMENTATION THRESHOLD VALUE DEFAULT AUTO COMPUTE TIMEOUT DEFAULT DISABLE TOTAL NUMBER DEFAULT ALL ABSOLUTE APERTURE SIZE DEFAULT ABSOLUTE APERTURE SIZE INPUT UNITS DEFAULT PIXEL WORLD APERTURE MODE DEFAULT ABSOLUTE DISABLE RELATIVE EXTENDED AREA REFLECTANCE CHECK DEFAULT DISABLE ENABLE GRADE QUIET ZONE DEFAULT DISABLE ENABLE GRADING STANDARD ISO DPM GRADING ISO GRADING SEMI T10 GRADING INSPECTION BAND RATIO DEFAULT MAXIMUM CALIBRATED REFLECTANCE DEFAULT MEAN LIGHT CALIBRATION DEFAULT MINIMUM CALIBRATED REFLECTANCE DEFAULT NUMBER OF SCANLINES DEFAULT ALL PIXEL SIZE IN MM DEFAULT UNKNOWN REFLECTANCE CALIBRATION DEFAULT RELATIVE APERTURE FACTOR DEFAULT AUTO SYSTEM RESPONSE CALIBRATION DEFAULT SYSTEM RESPONSE TARGET DEFAULT TRAIN TIMEOUT DEFAULT DISABLE CODE TYPE 4 STATE AZTEC BC412 CODABAR CODE39 CODE93 CODE128 COMPOSITECODE DATAMATRIX EAN8 EAN13 EAN14 GS1 128 GS1 DATABAR INDUSTRIAL25 INTERLEAVED25 MAXICODE MICROPDF417 MICROQRCODE PDF417 PHARMACODE PLANET POSTNET QRCODE TRUNCATED PDF417 UPC A UPC E BEARER BAR DEFAULT ABSENT PRESENT CELL NUMBER X MAX DEFAULT ANY CELL NUMBER X MIN DEFAULT ANY CELL NUMBER Y MAX DEFAULT ANY CELL NUMBER Y MIN DEFAULT ANY CELL SIZE MAX DEFAULT CELL SIZE MIN DEFAULT CHECK FINDER PATTERN DEFAULT DISABLE ENABLE CHECK QUIET ZONE DEFAULT DISABLE ENABLE CODE FLIP DEFAULT ANY FLIP NO FLIP CODE SEARCH MODE DEFAULT BEST FAST DATAMATRIX SHAPE DEFAULT ANY RECTANGLE SQUARE DECODE ALGORITHM DEFAULT CODE DEFORMED CODE NOT DEFORMED DOT SPACING INPUT UNITS DEFAULT PIXEL WORLD DOT SPACING MAX DEFAULT DOT SPACING MIN DEFAULT ECC CORRECTED NUMBER DEFAULT DISABLE ENABLE FINDER PATTERN EXHAUSTIVE SEARCH DEFAULT DISABLE ENABLE FINDER PATTERN INPUT UNITS DEFAULT PIXEL WORLD FINDER PATTERN MAX GAP DEFAULT AUTO FINDER PATTERN MINIMUM LENGTH DEFAULT AUTO NUMBER DEFAULT ALL POSITION ACCURACY DEFAULT HIGH LOW SEARCH ANGLE DEFAULT ACCORDING TO REGION SEARCH ANGLE DELTA NEG DEFAULT SEARCH ANGLE DELTA POS DEFAULT SEARCH ANGLE INPUT UNITS DEFAULT PIXEL WORLD SEARCH ANGLE STEP DEFAULT DISABLE STRING SIZE MAX DEFAULT ANY STRING SIZE MIN DEFAULT ANY SUB TYPE DEFAULT ANY EAN8 EAN13 GS1 128 GS1 DATABAR EXPANDED GS1 DATABAR EXPANDED STACKED GS1 DATABAR LIMITED GS1 DATABAR OMNI GS1 DATABAR STACKED GS1 DATABAR STACKED OMNI GS1 DATABAR TRUNCATED UPC A UPC E USE PRESEARCH DEFAULT DISABLE FINDER PATTERN BASE STAT BASE CELL NUMBER X DEFAULT ANY CELL NUMBER Y DEFAULT ANY CELL SIZE INPUT UNITS DEFAULT PIXEL WORLD ENCODING DEFAULT ANY ENC ALPHA ENC ALPHANUM ENC ALPHANUM PUNC ENC ASCII ENC AUSTRALIA MAIL C ENC AUSTRALIA MAIL N ENC AUSTRALIA MAIL RAW ENC AZTEC COMPACT ENC AZTEC FULL RANGE ENC AZTEC RUNE ENC EAN8 ENC EAN8 ADDON ENC EAN13 ENC EAN13 ADDON ENC GS1 128 MICROPDF417 ENC GS1 128 PDF417 ENC GS1 DATABAR EXPANDED ENC GS1 DATABAR EXPANDED STACKED ENC GS1 DATABAR LIMITED ENC GS1 DATABAR OMNI ENC GS1 DATABAR STACKED ENC GS1 DATABAR STACKED OMNI ENC GS1 DATABAR TRUNCATED ENC ISO8 ENC KOREA MAIL ENC MODE2 ENC MODE3 ENC MODE4 ENC MODE5 ENC MODE6 ENC NUM ENC QRCODE MODEL1 ENC QRCODE MODEL2 ENC STANDARD ENC UK MAIL ENC UPCA ENC UPCA ADDON ENC UPCE ENC UPCE ADDON ENC US MAIL ERROR CORRECTION DEFAULT ANY ECC 4STATE ECC 200 ECC CHECK DIGIT ECC COMPOSITE ECC H ECC L ECC M ECC NONE ECC Q ECC REED SOLOMON ECC REED SOLOMON n FOREGROUND VALUE DEFAULT FOREGROUND ANY FOREGROUND BLACK FOREGROUND WHITE TRAIN DEFAULT DISABLE ENABLE GRADING STANDARD EDITION ISO 15415 2011 15416 2000 ISO 15415 2011 15416 2016 ISO 15416 2000 ISO 15416 2016 ISO 29158 2011 SEMI T10 0701 CELL SIZE MODE DEFAULT AUTO USER DEFINED CELL SIZE VALUE DEFAULT DOT SHAPE DEFAULT CIRCLE SQUARE DOT SIZE DEFAULT RESULT OUTPUT UNITS DEFAULT ACCORDING TO CALIBRATION PIXEL WORLD STRING FORMAT DEFAULT AUTO FORMAT GS1 HUMAN READABLE JAPANESE KOREAN LATIN RAW DATA SIMPLIFIED CHINESE UPCE COMPRESSED UTF8 SUPPORTED NULL DEFAULT TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 M_ECC_REED_SOLOMON_n