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

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.