McodeInquire
| Board | Supported |
|---|---|
| Host System | Yes |
| V4L2 | Yes |
| Clarity UHD | Yes |
| Concord PoE | No |
| GenTL | Yes |
| GevIQ | Yes |
| GigE Vision | Yes |
| Indio | No |
| Iris GTX | Yes |
| Radient eV-CL | Yes |
| Rapixo CL | Yes |
| Rapixo CoF | Yes |
| Rapixo CXP | Yes |
| USB3 Vision | Yes |
Inquire about a code context, code model, or code result setting.
Syntax
AIL_INT McodeInquire(
AIL_ID CodeId, //in
AIL_INT64 InquireType, //in
void * UserVarPtr //out
)
Description
This function inquires about a setting of the specified code context, code model, or code result buffer.
Parameters
CodeId (in, AIL_ID)
Specifies the identifier of the code context, code model, or code result buffer.
InquireType (in, AIL_INT64)
Specifies the setting about which to inquire.
UserVarPtr *(out, void)
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.
Parameter Associations
For inquiring about code context or result buffer settings
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 CodeId parameter to a code context or code result buffer.
M_OWNER_SYSTEM
Inquires the identifier of the system on which the code context or code result buffer has been allocated.
| Value | Description |
|---|---|
M_DEFAULT_HOST | Specifies the default Host system of the current Aurora Imaging Library application. |
System identifier | Specifies a valid system identifier, previously allocated using MsysAlloc. |
M_SUPPORTED_CODE_TYPES
Inquires all code types supported by the module.
| Value | Description |
|---|---|
M_4_STATE | Specifies a 4-state code type. |
M_BC412 | Specifies a BC412 code type. |
M_CODABAR | Specifies a Codabar code type. |
M_CODE39 | Specifies a Code 39 code type. |
M_CODE93 | Specifies a Code 93 code type. |
M_CODE128 | Specifies a Code 128 code type. |
M_EAN8 | Specifies an EAN 8 code type. |
M_EAN13 | Specifies an EAN 13 code type. |
M_EAN14 | Specifies an EAN 14 code type. |
M_GS1_128 | Specifies a GS1-128 code type. |
M_GS1_DATABAR | Specifies a GS1 Databar code type. |
M_IATA25 | Specifies an IATA 2 of 5 code type. |
M_INDUSTRIAL25 | Specifies an Industrial 2 of 5 (standard 2 of 5) code type. |
M_INTERLEAVED25 | Specifies an Interleaved 2 of 5 (ITF-14) code type. |
M_PHARMACODE | Specifies a Pharmacode code type. |
M_PLANET | Specifies a Planet code type. |
M_POSTNET | Specifies a Postnet code type. |
M_UPC_A | Specifies a UPC-A code type. |
M_UPC_E | Specifies a UPC-E code type. |
M_AZTEC | Specifies an Aztec code type. |
M_DATAMATRIX | Specifies a Data Matrix code type. |
M_DOTCODE | Specifies a DotCode code type. |
M_MAXICODE | Specifies a Maxicode code type. |
M_MICROPDF417 | Specifies a MicroPDF417 code type. |
M_MICROQRCODE | Specifies a Micro QR code type. |
M_PDF417 | Specifies a PDF417 code type. |
M_QRCODE | Specifies a QR code type. |
M_TRUNCATED_PDF417 | Specifies a Truncated PDF417 code type. |
M_COMPOSITECODE | Specifies a composite code type. |
M_SUPPORTED_CODE_TYPES_1D
Inquires all 1D code types supported by the module.
| Value | Description |
|---|---|
M_BC412 | Specifies a BC412 code type. |
M_CODABAR | Specifies a Codabar code type. |
M_CODE39 | Specifies a Code 39 code type. |
M_CODE93 | Specifies a Code 93 code type. |
M_CODE128 | Specifies a Code 128 code type. |
M_EAN8 | Specifies an EAN 8 code type. |
M_EAN13 | Specifies an EAN 13 code type. |
M_EAN14 | Specifies an EAN 14 code type. |
M_GS1_128 | Specifies a GS1-128 code type. |
M_GS1_DATABAR | Specifies a GS1 Databar code type. |
M_IATA25 | Specifies an IATA 2 of 5 code type. |
M_INDUSTRIAL25 | Specifies an Industrial 2 of 5 (standard 2 of 5) code type. |
M_INTERLEAVED25 | Specifies an Interleaved 2 of 5 (ITF-14) code type. |
M_PHARMACODE | Specifies a Pharmacode code type. |
M_UPC_A | Specifies a UPC-A code type. |
M_UPC_E | Specifies a UPC-E code type. |
M_SUPPORTED_CODE_TYPES_2D
Inquires all 2D code types supported by the module.
| Value | Description |
|---|---|
M_AZTEC | Specifies an Aztec code type. |
M_DATAMATRIX | Specifies a Data Matrix code type. |
M_DOTCODE | Specifies a DotCode code type. |
M_MAXICODE | Specifies a Maxicode code type. |
M_MICROPDF417 | Specifies a MicroPDF417 code type. |
M_MICROQRCODE | Specifies a Micro QR code type. |
M_PDF417 | Specifies a PDF417 code type. |
M_QRCODE | Specifies a QR code type. |
M_TRUNCATED_PDF417 | Specifies a Truncated PDF417 code type. |
M_SUPPORTED_CODE_TYPES_DETECT
Inquires all code types supported by McodeDetect.
| Value | Description |
|---|---|
(see AcceptedCodeTypes) |
M_SUPPORTED_CODE_TYPES_POSTAL
Inquires all postal code types supported by the module.
| Value | Description |
|---|---|
M_4_STATE | Specifies a 4-state code type. |
M_PLANET | Specifies a Planet code type. |
M_POSTNET | Specifies a Postnet code type. |
Combination Constants — For determining the required array size (number of elements) to store the returned values
Optional, cannot be used alone.
Usage: You can add one of the following values to the above-mentioned values to determine the required array size (number of elements) to store the returned values.
M_NB_ELEMENTS
Retrieves the required array size (number of elements) to store the returned values.
For inquiring about the number of code models in a code context
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 CodeId parameter to a code context.
M_NUMBER_OF_CODE_MODELS
Inquires the number of code models in the code context.
| Value | Description |
|---|---|
Value >= 0 | Specifies the number of code models in the code context. |
For inquiring about code context settings that affect an
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 CodeId parameter to a code context. > Note: 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.
M_INITIALIZATION_MODE
Inquires the initialization mode of the code context.
| Value | Description |
|---|---|
M_DEFAULT | |
M_IMPROVED_RECOGNITION | Specifies a code context that might provide a more robust McodeRead, McodeGrade, or McodeTrain operation. |
M_TYPICAL_RECOGNITION (default) | Specifies a code context that might provide a quicker McodeRead or McodeGrade operation, but might potentially produce less robust results. |
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 code types (excluding M_PLANET and M_POSTNET), the M_DOTCODE code type, and 2D cross-row code types. Note that training the corresponding control type (M_TRAIN) is only supported for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value; the default value is 50. |
0 <= Value <= 255 | Specifies the minimum contrast. |
M_SCANLINE_HEIGHT
Inquires the scanline height (or thickness). This inquire type is only available for 1D code types (excluding M_4_STATE, M_PLANET, and M_POSTNET), 2D cross-row code types, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies a default scanline height that is based on the code type. |
Value | Specifies the scanline height, relative to the input coordinate system specified using M_SCANLINE_INPUT_UNITS. |
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 (excluding M_4_STATE, M_PLANET, and M_POSTNET), 2D cross-row code types, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the values in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the values in world units, with respect to the relative coordinate system. |
M_SCANLINE_STEP
Inquires the scanline step (or interval). This inquire type is only available for 1D code types (excluding M_4_STATE, M_PLANET, and M_POSTNET), 2D cross-row code types, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies a default scanline step that is based on the value of M_SPEED. |
Value | Specifies the scanline step, relative to the input coordinate system specified using M_SCANLINE_INPUT_UNITS. |
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE | Specifies that the search angular range algorithm is not used. |
M_ENABLE (default) | Specifies that the search angular range algorithm is used. |
M_SPEED
Inquires the search speed. This inquire type is available for all code types except M_DOTCODE.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the initialization mode. |
M_HIGH | Specifies a high search speed. |
M_LOW | Specifies a low search speed. |
M_MEDIUM | Specifies a medium search speed. |
M_VERY_HIGH | Specifies a very high search speed. |
M_VERY_LOW | Specifies a very low search speed. |
M_THRESHOLD_MODE
Inquires the threshold mode used to internally binarize the source image.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_ADAPTIVE | Specifies to use a fast dynamic local threshold. |
M_GLOBAL_SEGMENTATION | Specifies to use a global threshold value. |
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. |
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO_COMPUTE (default) | Specifies the threshold value automatically. |
0 <= Value <= 255 | Specifies the threshold value. |
M_TIMEOUT
Inquires the maximum decoding time for an McodeRead or McodeGrade operation, in msec.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE | Specifies that there is no maximum decoding time. |
Value >= 0 (default) | Specifies the maximum decoding time, in msec. |
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 M_GS1_DATABAR, M_4_STATE, M_PLANET, and M_POSTNET code types), the M_DOTCODE code type, and the M_DATAMATRIX code type support searching for multiple occurrences. Note that for M_DATAMATRIX and M_DOTCODE code types, M_TOTAL_NUMBER and M_NUMBER always return the same value because a code context can only contain multiple code models of the above-mentioned 1D code types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ALL (default) | 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). |
Value > 0 | Specifies the maximum number of codes to read/grade in one source image. |
For inquiring about code context settings that affect an
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 CodeId parameter to a code context. > Note: 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.
M_ABSOLUTE_APERTURE_SIZE
Inquires the absolute size (diameter) of the aperture.
| Value | Description |
|---|---|
M_DEFAULT | |
Value >= 0 (default) | Specifies the absolute aperture size, relative to the input coordinate system specified using M_ABSOLUTE_APERTURE_SIZE_INPUT_UNITS. |
M_ABSOLUTE_APERTURE_SIZE_INPUT_UNITS
Inquires the units with which to interpret the M_ABSOLUTE_APERTURE_SIZE inquire type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the value in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the value in world units, with respect to the relative coordinate system. |
M_APERTURE_MODE
Inquires the way in which the aperture size is determined.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ABSOLUTE | Specifies to use the absolute aperture size, set using M_ABSOLUTE_APERTURE_SIZE. |
M_DISABLE | Specifies to disable the aperture. |
M_RELATIVE (default) | 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). |
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 inquire type is only available for M_AZTEC, M_DATAMATRIX, M_DOTCODE, M_QRCODE, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies to disable the additional reflectance check. |
M_ENABLE | Specifies to enable the additional reflectance check. |
M_GRADE_QUIET_ZONE
Inquires whether to include the quiet zone when performing an McodeGrade operation. This inquire type is only available for M_DATAMATRIX, M_DOTCODE, M_QRCODE, and M_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE | Specifies to exclude the quiet zone. |
M_ENABLE (default) | Specifies to include the quiet zone. |
M_GRADING_STANDARD
Inquires the grading standard used when performing anMcodeGrade operation.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ISO_DPM_GRADING | Specifies an ISO/IEC 29158 specification. |
M_ISO_GRADING (default) | Specifies an ISO/IEC 15416 or ISO/IEC 15415 specification. |
M_SEMI_T10_GRADING | Specifies a Semi T10 specification. |
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, 2D cross-row code types, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default percentage. |
0.0 < Value < 100.0 | Specifies the percentage of the average bar height used as the height of the inspection band. |
M_LIGHTING_CONFIGURATION
Inquires the tilted coaxial lighting and camera angle position (TCL) relative to the marked object. This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_QRCODE, and M_MICROQRCODE code types.
| Value | Description |
|---|---|
M_90_DEGREE | Specifies the TCL is 90 degrees relative to the marked object. |
M_UNSPECIFIED (default) | Specifies that the TCL is none of the other values. |
M_MAXIMUM_CALIBRATED_REFLECTANCE
Inquires the maximum possible grayscale value in the target image.
| Value | Description |
|---|---|
M_DEFAULT | |
0 <= Value <= 255 (default) | Specifies the maximum calibrated reflectance. |
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 29158 specification.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value; the default value is equal to the setting of M_MAXIMUM_CALIBRATED_REFLECTANCE. |
0 <= Value <= 255 | Specifies the mean intensity. |
M_MINIMUM_CALIBRATED_REFLECTANCE
Inquires the minimum possible grayscale value in the target image.
| Value | Description |
|---|---|
M_DEFAULT | |
0 <= Value <= 255 (default) | Specifies the minimum calibrated reflectance. |
M_NUMBER_OF_SCANLINES
Inquires the number of scanlines 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, 2D cross-row code types, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value. |
M_ALL | Specifies to use all possible scanlines inside the inspection band. |
Value > 0 | Specifies the number of scanlines to inspect. |
M_PIXEL_SIZE_IN_MM
Inquires the scale between a pixel and its physical measurement, in millimeters per pixel units.
| Value | Description |
|---|---|
M_DEFAULT | |
M_UNKNOWN (default) | Specifies that the scale between a pixel and its physical measurement is not known, in mm per pixel units. |
Value > 0 | Specifies the scale between a pixel and its physical measurement, in mm per pixel units. |
M_REFLECTANCE_CALIBRATION
Inquires the expected reflectance value (Rcal). This value is used during the target grading phase of the ISO/IEC 29158 specification.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value; the default value is equal to the setting of M_MAXIMUM_CALIBRATED_REFLECTANCE. |
0 <= Value <= 255 | Specifies the reflectance value. |
M_RELATIVE_APERTURE_FACTOR
Inquires the relative aperture factor.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO (default) | 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 29158 specification (depends on M_GRADING_STANDARD). |
0 <= Value <= 2 | Specifies the aperture factor. |
M_SYSTEM_RESPONSE_CALIBRATION
Inquires the System Response value derived during the reflectance calibration phase (SRcal) of the ISO/IEC 29158 specification. This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_QRCODE, and M_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | |
Value > 0.0 (default) | Specifies the System Response value for the reference code. |
M_SYSTEM_RESPONSE_TARGET
Inquires the System Response value derived during the target grading phase (SRtarget) of the ISO/IEC 29158 specification. This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_QRCODE, and M_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | |
Value > 0.0 (default) | Specifies the System Response value for the target code. |
For inquiring about code context settings that affect an
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 CodeId parameter to a code context.
M_TRAIN_TIMEOUT
Inquires the maximum training time for an McodeTrain operation.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies to disable the timeout. |
Value >= 0 | Specifies the timeout limit, in msec. |
For inquiring about a code model's code type
To inquire about the code type of a code model, set the InquireType parameter to the following value. In this case, set the CodeId parameter to a code model.
M_CODE_TYPE
Inquires the code type of the specified model.
| Value | Description |
|---|---|
M_ANY | Matches all code types. |
M_4_STATE | Specifies a 4-state code type. |
M_BC412 | Specifies a BC412 code type. |
M_CODABAR | Specifies a Codabar code type. |
M_CODE39 | Specifies a Code 39 code type. |
M_CODE93 | Specifies a Code 93 code type. |
M_CODE128 | Specifies a Code 128 code type. |
M_EAN8 | Specifies an EAN 8 code type. |
M_EAN13 | Specifies an EAN 13 code type. |
M_EAN14 | Specifies an EAN 14 code type. |
M_GS1_128 | Specifies a GS1-128 code type. |
M_GS1_DATABAR | Specifies a GS1 Databar code type. |
M_IATA25 | Specifies an IATA 2 of 5 code type. |
M_INDUSTRIAL25 | Specifies an Industrial 2 of 5 (standard 2 of 5) code type. |
M_INTERLEAVED25 | Specifies an Interleaved 2 of 5 (ITF-14) code type. |
M_PHARMACODE | Specifies a Pharmacode code type. |
M_PLANET | Specifies a Planet code type. |
M_POSTNET | Specifies a Postnet code type. |
M_UPC_A | Specifies a UPC-A code type. |
M_UPC_E | Specifies a UPC-E code type. |
M_AZTEC | Specifies an Aztec code type. |
M_DATAMATRIX | Specifies a Data Matrix code type. |
M_DOTCODE | Specifies a DotCode code type. |
M_MAXICODE | Specifies a Maxicode code type. |
M_MICROPDF417 | Specifies a MicroPDF417 code type. |
M_MICROQRCODE | Specifies a Micro QR code type. |
M_PDF417 | Specifies a PDF417 code type. |
M_QRCODE | Specifies a QR code type. |
M_TRUNCATED_PDF417 | Specifies a Truncated PDF417 code type. |
M_COMPOSITECODE | Specifies a composite code type. |
For inquiring about code model settings that affect an
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 CodeId parameter to a code model. > Note: 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.
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ABSENT (default) | Specifies that no bearer bars are above and below the code. |
M_PRESENT | Specifies that there are bearer bars above and below the code. |
M_CELL_NUMBER_X_MAX
Inquires the maximum number of cells for which to search in the X-direction. 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for code occurrences with any number of cells. |
Value > 0 | Specifies the maximum number of cells for which to search. |
M_CELL_NUMBER_X_MIN
Inquires the minimum number of cells for which to search in the X-direction. 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for code occurrences with any number of cells. |
Value > 0 | Specifies the minimum number of cells for which to search. |
M_CELL_NUMBER_Y_MAX
Inquires the maximum number of cells for which to search in the Y-direction. 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for code occurrences with any number of cells. |
Value > 0 | Specifies the maximum number of cells for which to search. |
M_CELL_NUMBER_Y_MIN
Inquires the minimum number of cells for which to search in the Y-direction. 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for code occurrences with any number of cells. |
Value > 0 | Specifies the minimum number of cells for which to search. |
M_CELL_SIZE_MAX
Inquires the maximum cell size.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies to automatically select an appropriate size, which is dependent on the code type and the initialization mode. |
Value | Specifies the maximum cell size, relative to the input coordinate system specified using M_CELL_SIZE_INPUT_UNITS. |
M_CELL_SIZE_MIN
Inquires the minimum cell size.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies the default cell size, in pixels, which is dependent on the operation and code type. |
Value | Specifies the minimum cell size, relative to the input coordinate system specified using M_CELL_SIZE_INPUT_UNITS. |
M_CHECK_FINDER_PATTERN
Inquires whether checking for a false Data Matrix pattern is enabled. This inquire type is only available for the M_DATAMATRIX code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies that the Code module will not check for false M_DATAMATRIX code types. |
M_ENABLE | Specifies that the Code module will check for false M_DATAMATRIX code types. |
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: Note that the specifications of a code's quiet zone are dependent upon the code type.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
M_DISABLE | Specifies that a quiet zone is not necessary. |
M_ENABLE | Specifies that a quiet zone is necessary. |
M_CODE_FLIP
Inquires whether code occurrences need to be flipped or read in the opposite direction to be read properly.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the initialization mode. |
M_ANY | Allows Aurora Imaging Library to decide whether a code occurrence needs to be flipped or read in the opposite direction to be read properly. |
M_FLIP | Specifies that code occurrences need to be flipped or read in the opposite direction to be read properly. |
M_NO_FLIP | Specifies that code occurrences don't need to be flipped or read in the opposite direction. |
M_CODE_SEARCH_MODE
Inquires the behavior of the decoding algorithm. This inquire type is available for 1D code types (excluding M_4_STATE, M_PLANET, and M_POSTNET), the M_DOTCODE code type, and M_COMPOSITECODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
M_BEST | Specifies to search and return the best quality code occurrences. |
M_FAST | Specifies to search and return the first code occurrences decoded. |
M_DATAMATRIX_SHAPE
Inquires the shape of the Data Matrix code.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies that the M_DATAMATRIX code type can be any shape. |
M_RECTANGLE | Specifies that the M_DATAMATRIX code has a rectangular shape. |
M_SQUARE | Specifies that the M_DATAMATRIX code has a square shape. |
M_DECODE_ALGORITHM
Inquires the decoding algorithm used to read the code occurrences. This inquire type is available for M_AZTEC, M_DATAMATRIX, M_DOTCODE, M_QRCODE, M_PDF417, and M_TRUNCATED_PDF417 code types. Note that training the corresponding control type (M_TRAIN) is not supported for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_CODE_DEFORMED | Specifies to use the algorithm to decode deformed code occurrences. |
M_CODE_NOT_DEFORMED | Specifies to use the algorithm to decode non-deformed code occurrences. |
M_SCANLINE_AT_ANGLE | Specifies to use the algorithm to decode M_PDF417 or M_TRUNCATED_PDF417 code occurrences using rotated scanlines, without any localization. |
M_DOT_SIZE_INPUT_UNITS
Inquires the units with which to interpret the M_DOT_SIZE_MAX and M_DOT_SIZE_MIN inquire types. This inquire type is only available for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the values in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the values in world units, with respect to the relative coordinate system. |
M_DOT_SIZE_MAX
Inquires the maximum diameter of the dots for which to search. This inquire type is only available for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies the default value, which is dependent on the initialization mode. |
M_AUTO | Specifies to select an appropriate size, automatically. |
Value > 0 | Specifies the maximum dot size, relative to the input coordinate system specified using M_DOT_SIZE_INPUT_UNITS. |
M_DOT_SIZE_MIN
Inquires the minimum diameter of the dots for which to search. This inquire type is only available for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO | Specifies to select an appropriate size, automatically. |
Value > 0 (default) | Specifies the minimum dot size, relative to the input coordinate system specified using M_DOT_SIZE_INPUT_UNITS. |
M_DOT_SPACING_INPUT_UNITS
Inquires the units with which to interpret the M_DOT_SPACING_MAX and M_DOT_SPACING_MINinquire types. This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_MAXICODE, M_QRCODE, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies what convention is used, automatically. |
M_PIXEL (default) | Specifies to interpret the value in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the value in world units, with respect to the relative coordinate system. |
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, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies the default value, which is dependent on the initialization mode. |
-256 <= Value <= 256 | Specifies the distance, relative to the input coordinate system specified using M_DOT_SPACING_INPUT_UNITS. |
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, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies the default value, which is dependent on the initialization mode. |
-256 <= Value <= 256 | Specifies the distance, relative to the input coordinate system specified using M_DOT_SPACING_INPUT_UNITS. |
M_ECC_CORRECTED_NUMBER
Inquires whether McodeRead or McodeGradeare forced to perform a more robust operation to minimize the number of errors to correct. This inquire type is only available for M_PDF417 and M_TRUNCATED_PDF417 code types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies not to perform a more robust operation. |
M_ENABLE | Specifies to perform a more robust operation. |
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 the M_DATAMATRIX code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies to not perform an exhaustive search. |
M_ENABLE | Specifies to perform an exhaustive search. |
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 the M_DATAMATRIX code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the values in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the values in world units, with respect to the relative coordinate system. |
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 the M_DATAMATRIX code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO (default) | Specifies that the maximum tolerable gap in the finder pattern is 6 times the minimum cell size specified using M_CELL_SIZE_MIN. |
Value | Specifies the maximum gap allowed, in input units specified using M_FINDER_PATTERN_INPUT_UNITS. |
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 the M_DATAMATRIX code type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO (default) | Specifies that the minimum acceptable finder pattern "arm" length is 6 times the minimum cell size specified using M_CELL_SIZE_MIN. |
Value | The minimum acceptable finder pattern "arm" length, in input units specified using M_FINDER_PATTERN_INPUT_UNITS. |
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 M_GS1_DATABAR, M_4_STATE, M_PLANET, and M_POSTNET code types), the M_DOTCODE code type, and the M_DATAMATRIX code type support searching for multiple occurrences. Note that training the corresponding control type (M_TRAIN) is only supported for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_ALL | Specifies that all code model occurrences are read/graded up to the maximum number limited by M_TOTAL_NUMBER. |
Value >= 0 (default) | Specifies the maximum number of code occurrences of the specified code model to read or grade. |
M_POSITION_ACCURACY
Inquires the accuracy of positional results. Accuracy depends on the settings of the code context and its models.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_HIGH | Specifies to report the positional results of the code operation with high accuracy. |
M_LOW | Specifies to report the positional results of the code operation with low accuracy. |
M_SEARCH_ANGLE
Inquires the nominal search angle.
| Value | Description |
|---|---|
M_DEFAULT | |
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. |
0.0 <= Value <= 360.0 (default) | Specifies the nominal angle, in degrees, relative to the input coordinate system specified using M_SEARCH_ANGLE_INPUT_UNITS. |
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.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
0.0 <= Value <= 180.0 | Specifies a negative angular range, in degrees, relative to the nominal angle set by M_SEARCH_ANGLE. |
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.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
0.0 <= Value <= 180.0 | Specifies a positive angular range, in degrees, relative to the nominal angle set by M_SEARCH_ANGLE. |
M_SEARCH_ANGLE_INPUT_UNITS
Inquires the units with which to interpret the M_SEARCH_ANGLE inquire type.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the value in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the value in world units, with respect to the relative coordinate system. |
M_SEARCH_ANGLE_STEP
Inquires the angle increment/decrement used when searching for codes through an angular range. This inquire type is available for 1D code types (excluding M_4_STATE, M_PLANET, and M_POSTNET). It is also available for M_PDF417 and M_TRUNCATED_PDF417 code types when M_DECODE_ALGORITHM is set to M_SCANLINE_AT_ANGLE. Note that for M_PDF417 and M_TRUNCATED_PDF417 code types, 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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_DISABLE (default) | Specifies that no explicit increment/decrement is used. |
0.1 <= Value <= 180.0 | Specifies the explicit angle increment/decrement, in degrees. |
M_STRING_SIZE_MAX
Inquires the maximum size (number of characters) of the string encoded in a code occurrence. For M_QRCODE, M_MICROQRCODE, M_COMPOSITECODE, and M_GS1_DATABAR code types, the maximum string size is ignored when performing McodeRead and McodeGrade operations.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
M_ANY | Specifies that there is no maximum string size. |
0 <= Value <= 65535 | Specifies the maximum string size. |
M_STRING_SIZE_MIN
Inquires the minimum size (number of characters) of the string encoded in the code. For M_QRCODE, M_MICROQRCODE, M_COMPOSITECODE, and M_GS1_DATABAR code types, the minimum string size is ignored when performing McodeRead and McodeGrade operations.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
M_ANY | Specifies that there is no minimum string size. |
0 <= Value <= 65535 | Specifies the minimum string size. |
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for all of the code sub-types that can be specified for M_SUB_TYPE. |
M_EAN8 | Specifies that the EAN 8 code sub-type is enabled. |
M_EAN13 | Specifies that the EAN 13 code sub-type is enabled. |
M_GS1_128 | Specifies that the GS1-128 code sub-type is enabled. |
M_GS1_DATABAR_EXPANDED | Specifies that the GS1 Databar Expanded code sub-type is enabled. |
M_GS1_DATABAR_EXPANDED_STACKED | Specifies that the GS1 Databar Expanded Stacked code sub-type is enabled. |
M_GS1_DATABAR_LIMITED | Specifies that the GS1 Databar Limited code sub-type is enabled. |
M_GS1_DATABAR_OMNI | Specifies that the GS1 Databar Omnidirectional code sub-type is enabled. |
M_GS1_DATABAR_STACKED | Specifies that the GS1 Databar Stacked code sub-type is enabled. |
M_GS1_DATABAR_STACKED_OMNI | Specifies that the GS1 Databar Stacked Omnidirectional code sub-type is enabled. |
M_GS1_DATABAR_TRUNCATED | Specifies that the GS1 Databar Truncated code sub-type is enabled. |
M_UPC_A | Specifies that the UPC-A code sub-type is enabled. |
M_UPC_E | Specifies that the UPC-E code sub-type is enabled. |
M_USE_PRESEARCH
Inquires whether the localization operation is performed prior to the decoding step of an operation. This inquire type is available for 2D code types, excluding theM_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_DISABLE | Specifies that the operation is not performed. |
M_FINDER_PATTERN_BASE | Specifies that the localization operation is only performed on the base pattern of the M_DATAMATRIX code (an "L" starting at the top-most left corner, and ending on the bottom-most right corner of the code). |
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). |
For inquiring about code model settings that affect an
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 CodeId parameter to a code model. > Note: 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.
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for a code with any number of cells, when performing an McodeRead or McodeGrade operation. |
Value > 0 | Specifies the number of cells. |
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.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ANY (default) | Specifies to search for a code with any number of cells, when performing an McodeRead or McodeGrade operation. |
Value > 0 | Specifies the number of cells. |
M_CELL_SIZE_INPUT_UNITS
Inquires the units with which to interpret the M_CELL_SIZE_MAX and M_CELL_SIZE_MIN inquire types.
| Value | Description |
|---|---|
M_DEFAULT | |
M_PIXEL (default) | Specifies to interpret the values in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies to interpret the values in world units, with respect to the relative coordinate system. |
M_ENCODING
Inquires the type of encoding scheme. Note that training the corresponding control type (M_TRAIN) is not supported for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies to use the default encoding scheme, which is dependent on the code type and the initialization mode. |
M_ANY | Specifies any type of encoding scheme. |
M_ENC_ALPHA | Specifies an encoding scheme that supports uppercase alphabetical characters, along with the space. |
M_ENC_ALPHANUM | Specifies an encoding scheme that supports alphanumeric characters, as well as the space. |
M_ENC_ALPHANUM_PUNC | Specifies a similar encoding scheme to M_ENC_ALPHANUM, except it also supports the following characters: (,), (-), (/) and (.). |
M_ENC_ASCII | Specifies an encoding scheme that supports ASCII characters. |
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. |
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. |
M_ENC_AUSTRALIA_MAIL_RAW | Specifies an encoding scheme for a 4-state format used by the Australian Mail service. |
M_ENC_AZTEC_COMPACT | Specifies an encoding scheme for a compact Aztec code. |
M_ENC_AZTEC_FULL_RANGE | Specifies an encoding scheme for a full-range (not compact) Aztec code. |
M_ENC_AZTEC_RUNE | Specifies an encoding scheme for an Aztec rune (the smallest version of an Aztec code). |
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. |
M_ENC_EAN8_ADDON | Specifies an encoding scheme for an EAN 8 format with a supplemental 2 or 5 digit add-on. |
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. |
M_ENC_EAN13_ADDON | Specifies an encoding scheme for an EAN 13 format with a supplemental 2 or 5 digit add-on. |
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. |
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. |
M_ENC_GS1_DATABAR_EXPANDED | Specifies an encoding scheme that uses a GS1 Databar format. |
M_ENC_GS1_DATABAR_EXPANDED_STACKED | Specifies an encoding scheme that uses a GS1 Databar Expanded Stacked format. |
M_ENC_GS1_DATABAR_LIMITED | Specifies an encoding scheme that uses a GS1 Databar Limited format. |
M_ENC_GS1_DATABAR_OMNI | Specifies an encoding scheme that uses a GS1 Databar format. |
M_ENC_GS1_DATABAR_STACKED | Specifies an encoding scheme that uses a GS1 Databar Stacked format. |
M_ENC_GS1_DATABAR_STACKED_OMNI | Specifies an encoding scheme that uses a GS1 Databar Stacked Omnidirectional format. |
M_ENC_GS1_DATABAR_TRUNCATED | Specifies an encoding scheme that uses a GS1 Databar Truncated format. |
M_ENC_ISO8 | Specifies a similar encoding scheme as M_ENC_ASCII, but supports the extended ASCII character set. |
M_ENC_KOREA_MAIL | Specifies an encoding scheme for a 4-state format used by the Korean Mail service. |
M_ENC_MODE2 | Specifies an encoding scheme that requires a Structured Carrier Message. |
M_ENC_MODE3 | Specifies an encoding scheme that requires a Structured Carrier Message. |
M_ENC_MODE4 | Specifies an encoding scheme that requires a Free Format Message. |
M_ENC_MODE5 | Specifies an encoding scheme that requires a Free Format Message. |
M_ENC_MODE6 | Specifies an encoding scheme that requires a Free Format Message. |
M_ENC_NUM | Specifies an encoding scheme that only supports numbers. |
M_ENC_QRCODE_MODEL1 | Specifies an encoding scheme that uses an older version of the QR code format. |
M_ENC_QRCODE_MODEL2 | Specifies an encoding scheme that uses a newer version of the QR code format. |
M_ENC_STANDARD | Specifies different types of encoding schemes, depending on what code type is used. |
M_ENC_UK_MAIL | Specifies an encoding scheme for a 4-state format used by the UK Mail service. |
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. |
M_ENC_UPCA_ADDON | Specifies an encoding scheme for an UPC-A format with a supplemental 2 or 5 digit add-on. |
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. |
M_ENC_UPCE_ADDON | Specifies an encoding scheme for an UPC-E format with a supplemental 2 or 5 digit add-on. |
M_ENC_US_MAIL | Specifies the Intelligent Mail Barcode encoding scheme for a 4-state format used by the US Mail service. |
5 <= Value <= 95 | Specifies the minimum amount of the symbol that contains error correction information, as a percentage. |
M_ERROR_CORRECTION
Inquires the type of error correction. Note that training the corresponding control type (M_TRAIN) is not supported for the M_DOTCODE code type.
| Value | Description |
|---|---|
M_DEFAULT (default) | Specifies to use the default error correction scheme for the code type. |
M_ANY | Specifies that the error correction type for McodeRead and McodeGrade operations is detected automatically. |
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. |
M_ECC_200 | Specifies to use a Reed-Solomon-based algorithm as an error correction scheme. |
M_ECC_CHECK_DIGIT | Specifies to use an additional digit to check whether there is an error or not. |
M_ECC_COMPOSITE | Specifies to use the default error correction scheme for the 1D and 2D portions of the composite code. |
M_ECC_H | Specifies to use the highest-level error correction scheme. |
M_ECC_L | Specifies to use the lowest-level error correction scheme. |
M_ECC_M | Specifies to use a medium-low level error correction scheme. |
M_ECC_NONE | Specifies no error correction. |
M_ECC_Q | Specifies to use a medium-high level error correction scheme. |
M_ECC_REED_SOLOMON | Specifies to use a Reed-Solomon type of error correction scheme. |
M_ECC_REED_SOLOMON_n | Specifies to use a Reed-Solomon type of error correction scheme. |
5 <= Value <= 95 | Specifies the minimum percentage of the symbol that contains error correction information. |
M_FOREGROUND_VALUE
Inquires the foreground color of the code.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type and the initialization mode. |
M_FOREGROUND_ANY | Specifies the foreground color as black or white. |
M_FOREGROUND_BLACK | Specifies that the foreground color is black. |
M_FOREGROUND_WHITE | Specifies that the foreground color is white. |
Combination Constants — For inquiring whether the corresponding control type is activated for training
Optional.
Usage: You can add one of the following values to the above-mentioned values to determine whether the corresponding control type is activated for training.
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.
| Value | Description |
|---|---|
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. |
M_DISABLE | Specifies that the control type has not been activated for training. |
M_ENABLE | Specifies that the control type has been activated for training. |
For inquiring about code model settings that affect an
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 CodeId parameter must be set to the identifier of a code model. > Note: 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.
M_GRADING_STANDARD_EDITION
Inquires the grading standard edition used when performing an McodeGrade operation. This inquire type is available for all code types except M_MAXICODE.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the most recent grading standard edition that is supported, which is dependent on the code type. |
M_ISO_15415_2011_15416_2000 | Specifies the ISO/IEC 15415:2011 and ISO/IEC 15416:2000 specifications. |
M_ISO_15415_2011_15416_2016 | Specifies the ISO/IEC 15415:2011 and ISO/IEC 15416:2016 specifications. |
M_ISO_15416_2000 | Specifies the ISO/IEC 15416:2000 specification. |
M_ISO_15416_2016 | Specifies the ISO/IEC 15416:2016 specification. |
M_ISO_29158_2011 | Specifies the ISO/IEC 29158:2011 specification. |
M_ISO_29158_2020 | Specifies the ISO/IEC 29158:2020 specification. |
M_SEMI_T10_0701 | Specifies the Semi T10-0701 specification. |
For inquiring about code model settings that affect an
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 CodeId parameter must be set to the identifier of a code model. > Note: Note that you cannot set CodeId to the identifier of a code context when using the following inquire types.
M_CELL_SIZE_MODE
Inquires how to establish the cell size to use when performing an McodeWrite operation.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO (default) | 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. |
M_USER_DEFINED | Specifies that the cell size corresponds to the value of M_CELL_SIZE_VALUE. |
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.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
Value > 0.0 | Specifies the cell size. |
M_DOT_SHAPE
Inquires the shape of the dots used to draw foreground cells when performing an McodeWrite operation. This inquire type is only available for M_AZTEC, M_DATAMATRIX, M_DOTCODE, M_QRCODE, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
M_CIRCLE | Specifies that the foreground cells will be drawn with circular dots. |
M_SQUARE | Specifies that the foreground cells will be drawn with square dots. |
M_DOT_SIZE
Inquires the size of the dot (or square) used to draw foreground cells when performing an McodeWrite operation. This inquire type is only available for M_AZTEC, M_DATAMATRIX,M_DOTCODE, M_QRCODE, andM_MICROQRCODE code types.
| Value | Description |
|---|---|
M_DEFAULT | Specifies the default value, which is dependent on the code type. |
Value > 0.0 | Specifies the size of the dot or square. |
For inquiring about result buffer settings dealing with an
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.
M_RESULT_OUTPUT_UNITS
Inquires the units with which to interpret the results.
| Value | Description |
|---|---|
M_DEFAULT | |
M_ACCORDING_TO_CALIBRATION (default) | 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. |
M_PIXEL | Specifies that results are returned in pixel units, with respect to the pixel coordinate system. |
M_WORLD | Specifies that results are returned in world units, with respect to the relative coordinate system. |
For inquiring about result buffer settings dealing with an
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.
M_STRING_FORMAT
Inquires the format in which to return the string, retrieved using McodeGetResult with M_STRING.
| Value | Description |
|---|---|
M_DEFAULT | |
M_AUTO_FORMAT (default) | Specifies that the string is returned in the string format associated with the code type. |
M_GS1_HUMAN_READABLE | Specifies that the string is returned in a format that is human-readable. |
M_JAPANESE | Specifies that the string is returned in the Japanese (Windows-932) encoding. |
M_KOREAN | Specifies that the string is returned in the Korean (Windows-949) encoding. |
M_LATIN | Specifies that the returned string uses Latin (Windows-1252) encoding. |
M_RAW_DATA | Specifies that the string is returned in a raw data format. |
M_SIMPLIFIED_CHINESE | Specifies that the returned string uses Simplified Chinese (Windows-936) encoding. |
M_UPCE_COMPRESSED | Specifies that the returned string is in the UPCE compressed string format. |
M_UTF8 | Specifies that the returned string is in the UTF-8 string format. |
Combination Constants — For inquiring whether an inquire type is supported
Optional.
Usage: You can add one of the following values to the above-mentioned values to determine whether an inquire type is supported.
M_SUPPORTED
Inquires whether the specified inquire type is supported.
| Value | Description |
|---|---|
M_FALSE | Specifies that the inquire type is not supported. |
M_TRUE | Specifies that the inquire type is supported. |
Combination Constants — For inquiring about the default value of an inquire type
Optional.
Usage: You can add one of the following values to the above-mentioned values to determine the default value of an inquire type, regardless of the current value of the inquire type.
| Value | Description |
|---|---|
M_DEFAULT | Inquires the default value of the specified inquire type. |
Combination Constants — For specifying the data type
Optional.
Usage: You can add one of the following values to the above-mentioned values to cast the requested information to a required data type.
M_TYPE_AIL_DOUBLE
Casts the requested data to an AIL_DOUBLE.
M_TYPE_AIL_ID
Casts the requested data to an AIL_ID.
M_TYPE_AIL_INT
Casts the requested data to an AIL_INT.
M_TYPE_AIL_INT32
Casts the requested data to an AIL_INT32.
M_TYPE_AIL_INT64
Casts the requested data to an AIL_INT64.
Return Value
Type: AIL_INT
The returned value is the requested information, cast to an AIL_INT. If the requested information does not fit into an AIL_INT, this function will return M_NULLor truncate the information.
This inquire type is only available for 2D code types.
This inquire type is only available for the M_DATAMATRIX code type.
This inquire type is only available for M_AZTEC, M_DATAMATRIX, 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.