| MIL 10 Reference
| Customize Help
| Save Settings

McodeGetResult



See also
Availability
Not available in MIL-Lite
Available in MIL

Available on Windows
Available on Linux

Available on Non-Matrox computer
Available on Matrox 4Sight-X
Available on Matrox 4Sight GP
Available on Matrox Supersight
function map Function map
Examples
Synopsis
Get the specified type of result for all occurrences of all code models read or graded, using a code read or grading operation, respectively.
Syntax
void McodeGetResult(
MIL_ID ResultCodeId, //in
MIL_INT64 ResultType, //in
void *UserVarArrayPtr //out
)
Description

This function retrieves the result(s) of the specified type from a code result buffer for all occurrences of all code models read or graded. Results are only available after calling McodeRead() or McodeGrade().

From a grading operation, a resulting quality grade (such as, M_CONTRAST_UNIFORMITY_GRADE) is typically based on a calculation described in ISO/IEC 15415:2011. The calculation returns one result per codeword or one result for the code, depending on what was being graded. In most cases, there is a non-grade result which has more information about the test performed (such as, M_CONTRAST_UNIFORMITY). The grade is based on a scale from 4.0 to 0.0 that is converted to an alphabetic grade (A through F).

For more information on code model and code context settings required by McodeGrade(), see the Customizing read and grading operation settings section of Chapter 12: Codes.

If your target image was associated with a calibration context, positional and dimensional results are, by default, returned with respect to the relative coordinate system of the image. Otherwise, these results are returned in pixels, relative to the top-left pixel in the target image.

If your target image was associated with a calibration context but you want to retrieve positional and dimensional results in pixel units, use McodeControl() with the M_RESULT_OUTPUT_UNITS control type set to M_PIXEL. However, note that if you set M_RESULT_OUTPUT_UNITS to M_WORLD without specifying a calibrated target image in which to calculate the results, McodeGetResult() will generate an error.

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 if there is complementary information.
Parameters
This function is not supported on the selected boards.
Parameters
ResultCodeId

Specifies the identifier of the code result buffer from which to retrieve results.

ResultType

Specifies the type of result(s) to retrieve.

Not all result types are stored in the result buffer for all operations; the availability of results depends on which operation has been performed. In the tables below, the result types are grouped according to the operations after which they are available.

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

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

Specifies the address in which to place the specified result.

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

The tables below list possible values for the ResultType parameter and possible values returned to the UserVarArrayPtr parameter.

To retrieve a result that is returned for both code read and grading operations, the ResultType parameter can be set to one of the following values:

Unless otherwise specified, the following values require that you pass the UserVarArrayPtr parameter the address of a MIL_DOUBLE or the address of an array of type MIL_DOUBLE with a size equal to M_NUMBER (when more than one code is read or graded).

function map For retrieving results from a code read or grading operation
CollapseResultType Description
UserVarArrayPtr
- Possible values returned
Collapse M_CODE_MODEL_ID +

Retrieves the identifier of the code model that was used to read or grade the code. Note that this result is not valid when the results buffer is on a remote system. To find out which model was read on a remote system, use M_CODE_MODEL_INDEX instead.

(summarize)
Collapse M_CODE_MODEL_INDEX +

Retrieves the index of the code model, that was used to read or grade the code. Note that the number of codes read can be obtained using McodeGetResult() with M_NUMBER. When dealing with successful grading operations, the number of codes graded is always 1.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER

Collapse M_CODE_TYPE +

Retrieves the code type of the code that was read.

(summarize)
Collapse M_4_STATE

Specifies a 4-state code type.

Collapse M_AZTEC

Specifies an Aztec code type. INFO

Collapse M_BC412

Specifies a BC412 code type.

Collapse M_CODABAR

Specifies a Codabar code type.

Collapse M_CODE39

Specifies a Code 39 code type.

Collapse M_CODE93

Specifies a Code 93 code type.

Collapse M_CODE128

Specifies a Code 128 code type.

Collapse M_COMPOSITECODE

Specifies a composite code type. INFO

Collapse M_DATAMATRIX

Specifies a Data Matrix code type. INFO

Collapse M_EAN8

Specifies an EAN 8 code type.

Collapse M_EAN13

Specifies an EAN 13 code type.

Collapse M_EAN14

Specifies an EAN 14 code type.

Collapse M_GS1_128

Specifies a GS1-128 code type.

Collapse M_GS1_DATABAR

Specifies a GS1 Databar code type.

Collapse M_INDUSTRIAL25

Specifies an Industrial 2 of 5 (standard 2 of 5) code type.

Collapse M_INTERLEAVED25

Specifies an Interleaved 25 (ITF-14) code type. INFO

Collapse M_MAXICODE

Specifies a Maxicode code type. INFO

Collapse M_MICROPDF417

Specifies a MicroPDF417 code type. INFO

Collapse M_MICROQRCODE

Specifies a Micro QR code type. INFO

Collapse M_PDF417

Specifies a PDF417 code type. INFO

Collapse M_PHARMACODE

Specifies a Pharmacode code type.

Collapse M_PLANET

Specifies a Planet code type.

Collapse M_POSTNET

Specifies a Postnet code type.

Collapse M_QRCODE

Specifies a QR code type. INFO

Collapse M_TRUNCATED_PDF417

Specifies a Truncated PDF417 code type. INFO

Collapse M_UPC_A

Specifies a UPC-A code type.

Collapse M_UPC_E

Specifies a UPC-E code type.

Collapse M_DATA_CODEWORDS +

Retrieves the data codewords from the graphical representation of the code. Note that each codeword is returned as a numerical value, rather than as one or more alpha-numeric characters. The returned data codewords could be used to validate the code, as with PDF417, or to allow interpretation of the data codewords using a character set other than the default set supported by MIL. For more information, refer to the Extended Channel Interpretation (ECI) protocol in ISO/IEC 15438:2006.

To retrieve the decoded characters from the code, use M_STRING.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each code occurance. This number can be obtained using McodeGetResult() with M_NUMBER_OF_DATA_CODEWORDS x M_NUMBER

Collapse M_ENCODING +

Retrieves the type of encoding.

Note that since some versions of the GS1 Databar code types only differ by the bar height (and not the structure), the same result is returned for these similar code types. GS1 Databar omni and GS1 Databar Truncated will return M_ENC_GS1_DATABAR_OMNI. GS1 Databar Stacked and GS1 Databar Stacked Omnidirectional will return M_ENC_GS1_DATABAR_STACKED.

It is possible to obtain a more accurate result to distinguish between these structurally similar code types, using McodeControl() with M_POSITION_ACCURACY set to M_HIGH.

(summarize)
Collapse M_ENC_ALPHA

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

Collapse M_ENC_ALPHANUM

Specifies an encoding scheme that supports alphanumeric characters, as well as the space. INFO

Collapse M_ENC_ALPHANUM_PUNC

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

Collapse M_ENC_ASCII

Specifies an encoding scheme that supports ASCII characters. INFO

Collapse M_ENC_AUSTRALIA_MAIL_C

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

Collapse M_ENC_AUSTRALIA_MAIL_N

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

Collapse M_ENC_AUSTRALIA_MAIL_RAW

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

Collapse M_ENC_AZTEC_COMPACT

Specifies an encoding scheme for a compact Aztec code. INFO

Collapse M_ENC_AZTEC_FULL_RANGE

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

Collapse M_ENC_AZTEC_RUNE

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

Collapse M_ENC_EAN8

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

Collapse M_ENC_EAN8_ADDON

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

Collapse M_ENC_EAN13

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

Collapse M_ENC_EAN13_ADDON

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

Collapse M_ENC_GS1_128_MICROPDF417

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

Collapse M_ENC_GS1_128_PDF417

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

Collapse M_ENC_GS1_DATABAR_EXPANDED

Specifies an encoding scheme that uses a GS1 Databar format. INFO

Collapse M_ENC_GS1_DATABAR_EXPANDED_STACKED

Specifies an encoding scheme that uses a GS1 Databar Expanded Stacked format. INFO

Collapse M_ENC_GS1_DATABAR_LIMITED

Specifies an encoding scheme that uses a GS1 Databar Limited format. INFO

Collapse M_ENC_GS1_DATABAR_OMNI

Specifies an encoding scheme that uses a GS1 Databar format. INFO

Collapse M_ENC_GS1_DATABAR_STACKED

Specifies an encoding scheme that uses a GS1 Databar Stacked format. INFO

Collapse M_ENC_GS1_DATABAR_STACKED_OMNI

Specifies an encoding scheme that uses a GS1 Databar Stacked Omni format. INFO

Collapse M_ENC_GS1_DATABAR_TRUNCATED

Specifies an encoding scheme that uses a GS1 Databar Truncated format. INFO

Collapse M_ENC_ISO8

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

Collapse M_ENC_KOREA_MAIL

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

Collapse M_ENC_MODE2

Specifies an encoding scheme that requires a Structured Carrier Message. INFO

Collapse M_ENC_MODE3

Specifies an encoding scheme that requires a Structured Carrier Message. INFO

Collapse M_ENC_MODE4

Specifies an encoding scheme that requires a Free Format Message. INFO

Collapse M_ENC_MODE5

Specifies an encoding scheme that requires a Free Format Message. INFO

Collapse M_ENC_MODE6

Specifies an encoding scheme that requires a Free Format Message. INFO

Collapse M_ENC_NUM

Specifies an encoding scheme that only supports numbers. INFO

Collapse M_ENC_QRCODE_MODEL1

Specifies an encoding scheme that uses an older version of the QR code format. INFO

Collapse M_ENC_QRCODE_MODEL2

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

Collapse M_ENC_STANDARD

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

Collapse M_ENC_UK_MAIL

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

Collapse M_ENC_UPCA

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

Collapse M_ENC_UPCA_ADDON

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

Collapse M_ENC_UPCE

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

Collapse M_ENC_UPCE_ADDON

Specifies an encoding scheme for an UPC_E format with a supplemental 2 or 5 digit add-on. INFO

Collapse M_ENC_US_MAIL

Specifies an encoding scheme for a 4-state format used by the US Mail service. INFO

Collapse 5 <= Value <= 95

Specifies the minimum amount of the symbol that contains error correction information, as a percentage. INFO

Collapse M_ERROR_CORRECTION +

Retrieves the type of error correction scheme for the code.

(summarize)
Collapse M_ECC_4STATE

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

Collapse M_ECC_200

Specifies a Reed Solomon-based algorithm as an error correction scheme. INFO

Collapse M_ECC_CHECK_DIGIT

Specifies an additional digit to check whether there is an error or not. INFO

Collapse M_ECC_COMPOSITE

Specifies the default error correction scheme for the 1D and 2D portions of the composite code. INFO

Collapse M_ECC_H

Specifies the highest-level error correction scheme. INFO

Collapse M_ECC_L

Specifies the lowest-level error correction scheme. INFO

Collapse M_ECC_M

Specifies a medium-low level error correction scheme. INFO

Collapse M_ECC_n

Specifies an error correction algorithm that uses convolution coding. INFO

Collapse M_ECC_NONE

Specifies no error correction. INFO

Collapse M_ECC_Q

Specifies a medium-high level error correction scheme. INFO

Collapse M_ECC_REED_SOLOMON

Specifies a Reed Solomon type of error correction scheme. INFO

Collapse M_ECC_REED_SOLOMON_n

Specifies a Reed Solomon type of error correction scheme. INFO

Collapse M_ECC_UNKNOWN

Specifies an unknown error correction scheme.

Collapse 5 <= Value <= 95

Specifies the minimum percentage of the symbol that contains error correction information. INFO

Collapse M_EXTENDED_AREA_BOTTOM_LEFT_X +

Retrieves the bottom-left position along the X-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_BOTTOM_LEFT_Y +

Retrieves the bottom-left position along the Y-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_BOTTOM_RIGHT_X +

Retrieves the bottom-right position along the X-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_BOTTOM_RIGHT_Y +

Retrieves the bottom-right position along the Y-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_QUIET_ZONE_INCLUDED +

Retrieves whether the quiet zone and the extended area were included when reading or grading the code.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

This result type is only available when M_EXTENDED_AREA_REFLECTANCE_CHECK is enabled.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result were not available for the code.

Collapse M_FALSE

Specifies that the quiet zone and extended area were not included.

Collapse M_TRUE

Specifies that the quiet zone and extended area were included.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_EXTENDED_AREA_TOP_LEFT_X +

Retrieves the top-left position along the X-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_TOP_LEFT_Y +

Retrieves the top-left position along the Y-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_TOP_RIGHT_X +

Retrieves the top-right position along the X-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_TOP_RIGHT_Y +

Retrieves the top-right position along the Y-axis of a code read or graded, including the extended area.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_IS_GS1 +

Retrieves whether the code follows the industry standard for a GS1 code.

This result type is available for Aztec, Data Matrix, Code 128, EAN-14, GS1-128, GS1-Databar, QR codes, and composite codes.

(summarize)
Collapse M_FALSE

Specifies that the code does not follow the industry standard for a GS1 code.

Collapse M_TRUE

Specifies that the code follows the industry standard for a GS1 code.

Collapse M_NUMBER +

Retrieves the number of codes read for all code models in the code context, during the last read or grading operation. Note that multiple occurrences of the same model are counted separately.

(summarize)
Collapse M_NUMBER_OF_CODEWORDS +

Retrieves the number of codewords in the code; this includes data, overhead, and error correction codewords.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse M_NUMBER_OF_DATA_CODEWORDS +

Retrieves the number of data codewords in the code.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse M_NUMBER_OF_ERASURES +

Retrieves the number of erasures in the code. Erasures are missing or unreadable codewords at known positions.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse M_NUMBER_OF_ERROR_CORRECTION_CODEWORDS +

Retrieves the number of error correction codewords in the code. Error correction can be used to compensate for defects found during the decoding process.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse M_NUMBER_OF_ERRORS +

Retrieves the number of errors found in the code. Note that the number of errors does not include the number of erasures.

This result type is available for composite codes and 2D code types, with the exception of Data Matrix code types that do not use M_ERROR_CORRECTION with M_ECC_200.

(summarize)
Collapse M_QUIET_ZONE_BOTTOM_LEFT_X +

Retrieves the bottom-left position along the X-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_BOTTOM_LEFT_Y +

Retrieves the bottom-left position along the Y-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_BOTTOM_RIGHT_X +

Retrieves the bottom-right position along the X-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_BOTTOM_RIGHT_Y +

Retrieves the bottom-right position along the Y-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_INCLUDED +

Retrieves whether the quiet zone is included in the code.

(summarize)
Collapse M_FALSE

Specifies that the quiet zone is not included in the code.

Collapse M_TRUE

Specifies that the quiet zone is included in the code.

Collapse M_QUIET_ZONE_TOP_LEFT_X +

Retrieves the top-left position along the X-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_TOP_LEFT_Y +

Retrieves the top-left position along the Y-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_TOP_RIGHT_X +

Retrieves the top-right position along the X-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_QUIET_ZONE_TOP_RIGHT_Y +

Retrieves the top-right position along the Y-axis of a code read or graded, including the quiet zone.

(summarize)
Collapse M_STATUS +

Retrieves the status of a read or grading operation.

It can be helpful to obtain the number of codes read using McodeGetResult() with M_NUMBER, along with inquiring about M_STATUS. For example, if you set a code context to read two code occurrences and only one was found, the status returned is M_STATUS_NOT_FOUND. Calling McodeGetResult() with M_NUMBER will return 1.

Note that when reading multiple code occurrences and more than one read operation fails, the least-common error is returned. For example, if you read two codes and one fails because the code was not found (M_STATUS_NOT_FOUND) and the other fails because the encoding type was unknown (M_STATUS_ENC_UNKNOWN), the latter is returned.

To retrieve the confidence score of a read operation, use M_SCORE. To retrieve the confidence score of a grading operation as a grade, use M_OVERALL_SYMBOL_GRADE.

(summarize)
Collapse M_STATUS_CRC_FAILED

Specifies that the code read operation failed when validating the CRC (only for read operations).

Collapse M_STATUS_ECC_UNKNOWN

Specifies an unknown error correction type (only for read operations).

Collapse M_STATUS_ENC_UNKNOWN

Specifies an unknown encoding type (only for read operations).

Collapse M_STATUS_ENCODING_ERROR

Specifies that an error occurred when decoding the code (only for read operations).

Collapse M_STATUS_GRADE_FAILED

Specifies that the code grading operation failed (only for grading operations).

Collapse M_STATUS_GRADE_OK

Specifies that the code grading was successful (only for grading operations).

Collapse M_STATUS_NO_RESULT_AVAILABLE

Specifies that there are no results available (for read and grading operations).

Collapse M_STATUS_NOT_FOUND

Specifies that the code was not found (only for read operations).

Collapse M_STATUS_READ_OK

Specifies that the code read operation was successful (only for read operations).

Collapse M_STATUS_TIMEOUT_END

Specifies that the code operation timed out (for read and grading operations).

Collapse M_TIMEOUT_END +

Retrieves whether the timeout was reached. You can set the timeout limit using McodeControl() with M_TIMEOUT.

(summarize)
Collapse M_FALSE

Specifies that the timeout limit was not reached.

Collapse M_TRUE

Specifies that the timeout limit was reached.

To retrieve a result that is returned for a code read operation, the ResultType parameter can be set to one of the following values:

Unless otherwise specified, the following values require that you pass the UserVarArrayPtr parameter the address of a MIL_DOUBLE or the address of an array of type MIL_DOUBLE with a size equal to M_NUMBER (when more than one code is read).

function map For retrieving results from a code read operation
CollapseResultType Description
UserVarArrayPtr
- Possible values returned
Collapse M_ANGLE +

Retrieves the angle, in degrees, at which the code was read, relative to the output coordinate system specified using McodeControl() with M_RESULT_OUTPUT_UNITS.

An angle interpreted with respect to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 25: Calibrating your camera setup.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_BOTTOM_LEFT_X +

Retrieves the X-coordinate of the bottom-left corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_BOTTOM_LEFT_Y +

Retrieves the Y-coordinate of the bottom-left corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_BOTTOM_RIGHT_X +

Retrieves the X-coordinate of the bottom-right corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_BOTTOM_RIGHT_Y +

Retrieves the Y-coordinate of the bottom-right corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_CELL_NUMBER_X +

Retrieves the number of cells in the X-direction.

(summarize)
Collapse M_CELL_NUMBER_Y +

Retrieves the number of cells in the Y-direction.

(summarize)
Collapse M_CELL_SIZE +

Retrieves the size of the cell in X (module size (Z)) of the code that was read.

(summarize)
Collapse M_CODE_FLIP +

Retrieves whether the code was reversed or not.

(summarize)
Collapse M_FLIP

Specifies that the code was reversed.

Collapse M_NO_FLIP

Specifies that the code was not reversed.

Collapse M_FOREGROUND_VALUE +

Retrieves the foreground color of the code that was read.

(summarize)
Collapse M_POSITION_X +

Retrieves the X-coordinate of the occurrence. For all types of codes, except the Data Matrix and composite code types, this result is the center of the code in the X-direction. For Data Matrix codes, this result is the center, in the X-direction, of the top-left cell. For composite codes, this result is the center, in the X-direction, of the 1D component of the code. Note that to retrieve the top-left and bottom-right coordinates, use M_BOTTOM... and M_TOP....

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_POSITION_Y +

Retrieves the Y-coordinate of the occurrence. For all types of codes, except the Data Matrix and composite code types, this result is the center of the code in the Y-direction. For Data Matrix codes, this result is the center, in the Y-direction, of the top-left cell. For composite codes, this result is the center, in the Y-direction, of the 1D component of the code. Note that to retrieve the top-left and bottom-right coordinates, use M_BOTTOM... and M_TOP....

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_SCORE +

Retrieves the confidence score of a read operation. The code type determines how this value is calculated.

  • For linear 1D and GS1 Databar code types, the score is based on:

    • The number of redundant scan lines. Redundant scan lines can be omitted from a code, while still yielding the same result.

    • The difference between the actual code and the theoretical code model.

  • For 1D Planet, Postnet, and 4-state code types, the score is 1 if the code was read and 0 if it was not.

  • For 2D code types, the score is calculated using: 1 - (Number of errors)/(Number of error correction codewords).

    If the code could not be decoded successfully, the score is 0.

  • For 2D cross-row types, the score is calculated using: 1 - (Number of errors + Number of erasures)/(Number of codewords).

    If the code could not be decoded successfully, the score is 0.

  • For composite codes, the score is the score of either the 1D part or the 2D part; whichever was lower.

To retrieve the error status of the grading operation, use M_STATUS. To retrieve the confidence score of a grading operation as a grade, use M_OVERALL_SYMBOL_GRADE.

(summarize)
Collapse 0 <= Value <= 1

Specifies the confidence score of a read operation. 0 indicates 0% confidence and 1 indicates 100% confidence.

(summarize)
Collapse M_SIZE_X +

Retrieves the size of the code in the X-direction.

For composite code types, this result is the width of the 1D component of the code.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_SIZE_Y +

Retrieves the size of the code in the Y-direction.

For composite code types, this result is the height of the 1D component of the code.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_STRING +

Retrieves the decoded string.

If the string is decoded from a composite code model, the string is returned in the following format: 1D string|2D string, where | is used as the separator.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_TEXT_CHAR
Array size: Large enough to contain the decoded string (using either M_STRING_SIZE +1 (if reading one code), or M_TOTAL_STRING_SIZE (if reading multiple codes).

Collapse M_STRING_SIZE +

Retrieves the length of the decoded string.

(summarize)
Collapse M_THRESHOLD_MODE +

Retrieves the threshold mode used to internally binarize the source image of a read operation.

(summarize)
Collapse M_ADAPTIVE

Specifies to use a fast dynamic local threshold. For more information, see McodeControl() with M_THRESHOLD_MODE and M_ADAPTIVE.

(summarize)
Collapse M_GLOBAL_SEGMENTATION

Specifies to use a global threshold value. For more information, see McodeControl() with M_THRESHOLD_MODE and M_GLOBAL_SEGMENTATION.

(summarize)
Collapse 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. For more information, see McodeControl() with M_THRESHOLD_MODE and M_GLOBAL_WITH_LOCAL_RESEGMENTATION.

(summarize)
Collapse M_THRESHOLD_VALUE +

Retrieves the threshold value used to internally binarize the source image of a read operation.

(summarize)
Collapse M_TOP_LEFT_X +

Retrieves the X-coordinate of the top-left corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_TOP_LEFT_Y +

Retrieves the Y-coordinate of the top-left corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_TOP_RIGHT_X +

Retrieves the X-coordinate of the top-right corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_TOP_RIGHT_Y +

Retrieves the Y-coordinate of the top-right corner of the code that was read.

For 1D code types, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

(summarize)
Collapse M_TOTAL_STRING_SIZE +

Retrieves the total length of all decoded strings. This is equal to the sum of the individual decoded string lengths (including the terminating null character ("\0") of each string).

(summarize)
Collapse UserVarArrayPtr data type info

Data type: MIL_DOUBLE

Combination constant for M_STRING; M_STRING_SIZE; M_TOTAL_STRING_SIZE.

You can add the following value to the above-mentioned values to specify what type of symbols should be returned when dealing with unprintable characters.

function map For use with string result types
CollapseCombination value Description
Collapse M_ESCAPE_SEQUENCE

Retrieves the string with its unprintable characters represented by their ASCII character codes, when combined with M_STRING. Any back slashes (\) in the string are doubled, while unprintable characters, such as carriage returns, are put in a \xNN format, where NN is the hexadecimal value of the ASCII character code for the unprintable character.

When combined with M_STRING_SIZE, it returns the size of the string including its unprintable characters.

(summarize)

To retrieve a result that is returned for a code grading operation, the ResultType parameter can be set to one of the following values:

Unless otherwise specified, the following values require that you pass the UserVarArrayPtr parameter the address of a MIL_DOUBLE or the address of an array of type MIL_DOUBLE with a size equal to The number of occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER (when more than one code is graded).

function map For retrieving results from a code grading operation
CollapseResultType Description
UserVarArrayPtr
- Possible values returned
Collapse M_APERTURE_SIZE_USED +

Retrieves the aperture size used.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_ASTERISK +

Retrieves whether an asterisk is appended to the overall symbol grade. Typically, an asterisk is appended to the overall symbol grade when the region outside the extended area has a symbol contrast (reflectance) that might interfere with the read operation (for example, the region is too bright or too dark).

This result type is available for 2D matrix code types, except Maxicode.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_AXIAL_NONUNIFORMITY +

Retrieves the axial non-uniformity of the code. The axial non-uniformity is calculated using the following formula:

Where Xavg is the average cell size in the X-dimension and Yavg is the average measurement cell size in the Y-dimension.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the axial nonuniformity measure.

Collapse M_AXIAL_NONUNIFORMITY_GRADE +

Retrieves the axial nonuniformity of the code, as a grade.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CELL_CONTRAST +

Retrieves the cell contrast value (CC). The cell contrast is calculated as the difference between the average intensity of lighter cells minus the average intensity of darker cells, divided by the average intensity of lighter cells.

This result type is only available if McodeControl() with M_GRADING_STANDARD is set to M_AIMDPM_GRADING before McodeGrade() is called.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the CC value.

Collapse M_CELL_CONTRAST_GRADE +

Retrieves the cell contrast, as a grade.

This result type is only available if McodeControl() with M_GRADING_STANDARD is set to M_AIMDPM_GRADING before McodeGrade() is called.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CELL_MODULATION_GRADE +

Retrieves the modulation of the code, as a grade calculated using the ISO/IEC TR 29158:2011 standard. Modulation is a measure of the uniformity of reflectance in the dark and light areas of the code.

This result type is the AIMDPM version of M_MODULATION_GRADE.

This result type is only available if McodeControl() with M_GRADING_STANDARD is set to M_AIMDPM_GRADING before McodeGrade() is called.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CODEWORD_DECODABILITY +

Retrieves the measure of the print quality of each codeword relative to the decoding algorithm. Note that this excludes any start/stop patterns.

To retrieve the decodability of the start/stop patterns of your code, use M_SCAN_DECODABILITY.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODEWORD_DECODABILITY_GRADE +

Retrieves the decodability of each codeword in the code, as a grade.

To retrieve the decodability of the start/stop patterns of your code as a grade, use M_SCAN_DECODABILITY_GRADE.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CODEWORD_DEFECTS +

Retrieves and ranks the deviations in the expected signal that denotes a codeword in your code. The larger the result, the greater the defect in the codeword and the less likely that the codeword can be decoded without error.

To retrieve the defects for your code as a single grade use M_DEFECTS_GRADE. To retrieve the defects of the start/stop patterns use M_SCAN_DEFECTS.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODEWORD_DEFECTS_GRADE +

Retrieves the codeword defects, as a grade for each codeword.

To retrieve the defects for your code as a single grade use M_DEFECTS_GRADE. To retrieve the defects of the start/stop patterns use M_SCAN_DEFECTS_GRADE.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CODEWORD_MODULATION +

Retrieves the modulation (MOD) of each codeword. Modulation is a measure of the uniformity of reflectance in the dark and light areas of the code. For 2D cross-row and composite code types, modulation is calculated as the ratio of the minimum edge contrast (EC min) to symbol contrast (M_SYMBOL_CONTRAST) within the code.

To retrieve the modulation of the start/stop patterns of 2D cross-row and composite code types, use M_SCAN_MODULATION.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for Data Matrix, QR code, Micro QR, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODEWORD_MODULATION_GRADE +

Retrieves the modulation (MOD) of each codeword, as a grade.

To retrieve the modulation of your code as a single grade, use M_MODULATION_GRADE. To retrieve the modulation of the start/stop patterns of 2D cross-row and composite code types, as a grade, use M_SCAN_MODULATION_GRADE.

This result type is used in the grade overlay procedure for measuring codeword print quality, as described in the ISO 15415 specification.

This result type is available for Data Matrix, QR code, Micro QR, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CODEWORD_REFLECTANCE_MARGIN +

Retrieves the reflectance margin of each codeword.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned for all occurrences of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODEWORD_REFLECTANCE_MARGIN_GRADE +

Retrieves the reflectance margin for each codeword, as a grade.

To retrieve the modulation of your code as a single grade, use M_REFLECTANCE_MARGIN_GRADE.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CODEWORD_YIELD +

Retrieves the codeword yield result. The codeword yield result determines how well your code can be read at an angle relative to the horizontal and vertical axis of code. When all other results are good, a poor codeword yield result can indicate a problem along the Y-axis of your code. For more information, refer to the ISO/IEC 15415 specification.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the codeword yield.

Collapse M_CODEWORD_YIELD_GRADE +

Retrieves the codeword yield, as a single grade for the code.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_CONTRAST_UNIFORMITY +

Retrieves the contrast uniformity of the code. The contrast uniformity is the minimum (MOD) value for the code.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the contrast uniformity.

Collapse M_CONTRAST_UNIFORMITY_GRADE +

Retrieves the contrast uniformity, as a grade.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_DECODABILITY_GRADE +

Retrieves the measure of the print quality of the code relative to the decoding algorithm, as a grade.

To determine the decodability for each codeword in the code, use M_CODEWORD_DECODABILITY. To retrieve the decodability of the start/stop patterns of your code as a grade, use M_SCAN_DECODABILITY_GRADE.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_DECODE_GRADE +

Retrieves the code decodability, as a grade.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies that the code can be read.

Collapse M_CODE_GRADE_F

Specifies that the code cannot be read.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_DEFECTS_GRADE +

Retrieves the measure of defects in the code, as a grade.

To retrieve the measure of defects for each codeword as a grade, use M_CODEWORD_DEFECTS_GRADE. To retrieve the measure of defects in the start/stop patterns as a grade, use M_SCAN_DEFECTS_GRADE.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_DOT_SPACING_USED +

Retrieves the actual spacing between dots present in the code.

The expected dot spacing is set using McodeControl() with M_DOT_SPACING.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_CODEWORD_MODULATION +

Retrieves the modulation of each codeword found in the code's extended area beyond the quiet zone.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_INT64
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_EXTENDED_AREA_CODEWORD_MODULATION_GRADE +

Retrieves the modulation grade of each codeword found in the code's extended area beyond the quiet zone.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_INT64
Array size: The number of codewords scanned in each occurrence of the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_CODEWORDS x M_NUMBER

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_A1_GRADE +

Retrieves the grade of the A1 segment of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_A2_GRADE +

Retrieves the grade of the A2 segment of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_A3_GRADE +

Retrieves the grade of the A3 segment of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_AVERAGE_GRADE +

Retrieves the average grade of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_B1_GRADE +

Retrieves the grade of the B1 segment of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_B2_GRADE +

Retrieves the grade of the B2 segment of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_C_GRADE +

Retrieves the grade of the C segment of the specified QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_CLOCKTRACK_SOLID_GRADE +

Retrieves the grade of the clock pattern and adjacent solid area segments of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_GRADE +

Retrieves the grade of the specified QR code or Micro QR code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_L1_GRADE +

Retrieves the grade of the L1 segment of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_L2_GRADE +

Retrieves the grade of the L2 segment of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_QZL1_GRADE +

Retrieves the grade of the QZL1 segment of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_FIXED_PATTERN_DAMAGE_QZL2_GRADE +

Retrieves the grade of the QZL2 segment of the specified Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_MODULATION_GRADE +

Retrieves the grade of the modulation in the extended area beyond the quiet zone. Modulation is a measure of the uniformity of reflectance of the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_EXTENDED_AREA_REFLECTANCE_MAXIMUM +

Retrieves the greatest reflectance within the extended area (that is, 20 times beyond the quiet zone) in any 2D code, except Maxicode.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_EXTENDED_AREA_REFLECTANCE_MINIMUM +

Retrieves the lowest reflectance within the extended area (that is, 20 times beyond the quiet zone) in any 2D code, except Maxicode.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_EXTENDED_AREA_SYMBOL_CONTRAST +

Retrieves the measure of the symbol contrast in the extended area (that is, 20 times beyond the quiet zone).

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_EXTENDED_AREA_SYMBOL_CONTRAST_GRADE +

Retrieves the modulation grade of the symbol contrast in the extended area (that is, 20 times beyond the quiet zone).

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_A1_GRADE +

Retrieves the fixed pattern damage in the A1 segment of the specified QR code or Micro QR code, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code. For a QR code, the alignment pattern is also analyzed.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_A2_GRADE +

Retrieves the fixed pattern damage in the A2 segment of the specified QR code as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_A3_GRADE +

Retrieves the fixed pattern damage in the A3 segment of the specified QR code, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_AVERAGE_GRADE +

Retrieves the average grade of the fixed pattern damage (FDP) of the specified Data Matrix code.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_B1_GRADE +

Retrieves the fixed pattern damage in the B1 segment of the specified QR code or Micro QR code, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code. For a QR code, the alignment pattern is also analyzed.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_B2_GRADE +

Retrieves the fixed pattern damage in the B1 segment of the specified QR code or Micro QR code, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code. For a QR code, the alignment pattern is also analyzed.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_C_GRADE +

Retrieves the fixed pattern damage in the C segment of the specified QR code, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_CLOCKTRACK_SOLID_GRADE +

Retrieves the grade of the clock pattern and adjacent solid area segments of the specified Data Matrix code.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_GRADE +

Retrieves the fixed pattern damage, as a grade. The fixed pattern damage (FPD) is a measure of the amount of damage present in the finder pattern, clock pattern, and quiet zone of the code. For a QR code, the alignment pattern is also analyzed.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_L1_GRADE +

Retrieves the grade of the L1 segment of a Data Matrix code, in the extended area (that is, 20 times beyond the quiet zone).

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_L2_GRADE +

Retrieves the grade of the L2 segment of a Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_QZL1_GRADE +

Retrieves the grade of the QZL1 segment of a Data Matrix code, in the quiet zone, along the left quadrant.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FIXED_PATTERN_DAMAGE_QZL2_GRADE +

Retrieves the grade of the QZL2 segment of a Data Matrix code, in the extended area beyond the quiet zone.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FORMAT_INFORMATION_1_GRADE +

Retrieves the readability of the format information in segment 1 of the code, as a grade. The format information is an embedded pattern that contains information about the characteristics of the code that are essential for further decoding.

This result type is available for QR code and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FORMAT_INFORMATION_2_GRADE +

Retrieves the readabilityof the format information in segment 2 of the code, as a grade. The format information is an embedded pattern that contains information about the characteristics of the code that are essential for further decoding.

This result type is available for QR code and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_FORMAT_INFORMATION_GRADE +

Retrieves the readability of the format information, as a grade. The format information is an embedded pattern that contains information about the characteristics of the code that are essential for further decoding.

This result type is available for QR code and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_GRID_NONUNIFORMITY +

Retrieves the grid nonuniformity value. Grid nonuniformity is calculated as the amount of deviation of the code's actual grid of an ideal grid.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the grid nonuniformity.

Collapse M_GRID_NONUNIFORMITY_GRADE +

Retrieves the grid nonuniformity, as a grade.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_MEAN_LIGHT_CALIBRATION +

Retrieves the mean intensity of the centers of the white elements of the reference code (MLcal).

This result is determined during the reflectance calibration phase of the ISO/IEC TR 29158:2011 standard. To start the target verification phase, you must retrieve this result and load it into the code context of the target code. Use McodeControl() with M_MEAN_LIGHT_CALIBRATION to load this result into the target code context; alternatively, you can call McodeControl() with M_AIMDPM_CALIBRATION_RESULTS.

This result type is available for all 1D, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse 0 <= Value <= 255

Specifies the mean intensity of the centers of the white elements.

Collapse M_MEAN_LIGHT_TARGET +

Retrieves the mean intensity of the centers of the white elements of the code to grade (MLtarget).

This result is determined during the target verification phase of the ISO/IEC TR 29158:2011 standard.

This result type is only available if McodeControl() with M_GRADING_STANDARD is set to M_AIMDPM_GRADING before McodeGrade() is called.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse 0 <= Value <= 255

Specifies the mean intensity of the centers of the white elements.

Collapse M_MINIMUM_REFLECTANCE +

Retrieves the amount of reflectance in the white elements of the code to grade.

To retrieve the lowest reflectance (Rmin) or the highest reflectance (Rmax), use M_R_MIN or M_R_MAX, respectively.

This result type is only available if McodeControl() with M_GRADING_STANDARD is set to M_AIMDPM_GRADING before McodeGrade() is called.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the amount of reflectance in the white elements, as a percentage.

Collapse M_MINIMUM_REFLECTANCE_GRADE +

Retrieves the minimum reflectance, as a grade.

This result type is available for Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_MODULATION_GRADE +

Retrieves the modulation of the code, as a grade calculated using the ISO standard. Modulation is a measure of the uniformity of reflectance in the dark and light areas of the code. For more information, refer to the ISO/IEC 15415 specification.

To retrieve the modulation of each codeword as a grade, use M_CODEWORD_MODULATION_GRADE. To retrieve the modulation of the start/stop patterns of 2D cross-row and composite code types, as a grade, use M_SCAN_MODULATION_GRADE. To retrieve the modulation of a code calculated using the ISO/IEC TR 29158:2011 standard, use M_CELL_MODULATION_GRADE.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_NUMBER_OF_ROWS +

Retrieves the number of rows graded in the code.

For GS1 Databar code types, the number of rows is the number of stacks in the code. For cross-row code types, the number of rows is the number of rows graded in the start/stop pattern grading.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_NUMBER_OF_SCANS +

Retrieves the total number of scan reflectance profiles analyzed in the code. This is the sum of the number of scans per row, for every row within the code. The number of scans determines the number of results within an array for all the M_SCAN... values described in this function.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_NUMBER_OF_SCANS_PER_ROW +

Retrieves the number of scan reflectance profiles per row. The number of scans determines the number of results within an array for all the M_SCAN... values described in this function.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_OVERALL_SYMBOL_GRADE +

Retrieves the overall symbol grade. The code type determines the calculation used to obtain the grade.

For 1D code types, the overall symbol grade is the average grade of the scan reflectance profile (using M_SCAN_REFLECTANCE_PROFILE_GRADE.

For composite code types, the overall symbol grade is the worst grade overall, obtained when analyzing either the 1D or the 2D portions.

For 2D code types, the overall symbol grade is the worst of all the returned grades.

For cross-row codes, the overall symbol grade is the worst of all possible grades (with the exception of M_SCAN...GRADE).

To retrieve the overall symbol grade for each row in the code, use M_ROW_OVERALL_GRADE.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_PRINT_GROWTH +

Retrieves the print growth value. The print growth is a value determining whether the graphical features of the code have either grown or shrunk, relative to theoretical model sufficiently to hinder readability.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse Value

Specifies the print growth value.

Collapse M_PRINT_GROWTH_GRADE +

Retrieves the print growth value, as a grade.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_R_MAX +

Retrieves the highest reflectance (Rmax) of a 2D Matrix code type, except Maxicode.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_R_MIN +

Retrieves the lowest reflectance (Rmin) of a 2D Matrix code type, except Maxicode.

To retrieve the amount of reflectance in the white elements of the code to grade, use M_MINIMUM_REFLECTANCE.

This result type requires that the specified code be graded using proper code verification techniques. For more information, refer to the ISO/IEC 15415 specification.

(summarize)
Collapse M_RECOMMENDED_APERTURE_SIZE +

Retrieves the recommended aperture size for the grading operation, following the ISO 15415 specification for 2D matrix codes and the ISO 15416 specification for all other available codes.

Note that, for 1D, 2D cross-row, and composite code types, this value depends on McodeControl() with M_PIXEL_SIZE_IN_MM. If M_PIXEL_SIZE_IN_MM is not set (or is set to M_UNKNOWN), the value returned is (0.5 x cell size).

If the M_PIXEL_SIZE_IN_MM is set to a value, the recommended aperture size is computed using the ISO 15416 specification.

For 2D matrix code types, the value returned is (0.8 x cell size), regardless of the value of M_PIXEL_SIZE_IN_MM.

This result type is available for 1D, 2D matrix, 2D cross-row, and composite code types.

(summarize)
Collapse M_REFLECTANCE_CALIBRATION +

Retrieves the maximum reflectance value derived during the reflectance calibration phase (Rcal).

This result is determined during the reflectance calibration phase of the ISO/IEC TR 29158:2011 standard. To start the target verification phase, you must retrieve this result and load it into the code context of the target code. Use McodeControl() with M_REFLECTANCE_CALIBRATION to load this result into the target code context; alternatively, you can call McodeControl() with M_AIMDPM_CALIBRATION_RESULTS.

This result type is available for 1D, Aztec, Data Matrix, QR code, and Micro QR code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 255

Specifies the maximum reflectance value.

Collapse M_REFLECTANCE_MARGIN_GRADE +

Retrieves the assessment of the codeword print quality, based on the reflectance margin, as a grade.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_ROW_OVERALL_GRADE +

Retrieves the overall grade for each row in the code.

To retrieve the average of all the row overall grades, use M_OVERALL_SYMBOL_GRADE.

For 1D code types, the overall row grade is the overall grade for the entire code.

For 2D code types, the overall row grade is the overall grade per stack of the code.

For cross-row code types, the overall row grade is the worst grade of the row.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of rows in the code. This number can be obtained using McodeGetResult() with M_NUMBER_OF_ROWS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_DECODABILITY +

Retrieves the decodability result of the scan reflectance profile.

To retrieve the decodability for each codeword, use M_CODEWORD_DECODABILITY. To retrieve the decodability for your code as a grade, use M_DECODABILITY_GRADE.

Note that certain code types have additional decodability measures that are taken into account when computing the decodability result. See the ISO 15417 (Code 128) and ISO 15420 (EAN and UPC code types) specifications.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the decodability value.

Collapse M_SCAN_DECODABILITY_GRADE +

Retrieves the decodability result of the scan reflectance profile, as a grade.

To retrieve the decodability for each codeword as a grade, use M_CODEWORD_DECODABILITY_GRADE. To retrieve the decodability for your cross-row code as a grade, use M_DECODABILITY_GRADE.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_DECODE_GRADE +

Retrieves whether the decoding algorithm succeeded or failed, as a grade.

To retrieve the error status of the grading operation, use M_STATUS. To retrieve the confidence score of a read operation, use M_SCORE.

Note that M_SCAN_EDGE_DETERMINATION_GRADE is used in calculating this value.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies that the decoding algorithm succeeded.

Collapse M_CODE_GRADE_F

Specifies that the decoding algorithm failed.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_DEFECTS +

Retrieves and ranks the defects in the scan reflectance profile. The result is based on the ERN maximum (M_SCAN_ERN_MAXIMUM) and code (symbol) contrast (M_SCAN_SYMBOL_CONTRAST).

To retrieve the ranking measure for each codeword, use M_CODEWORD_DEFECTS. To determine the measure of defects in the code as a grade, use M_DEFECTS_GRADE.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the ranking of the defects.

Collapse M_SCAN_DEFECTS_GRADE +

Retrieves the measure of defects of the scan reflectance profile, as a grade.

To retrieve the ranking measure of defects in each codeword, as a grade, use M_CODEWORD_DEFECTS_GRADE. To determine the measure of defects in the code, use M_DEFECTS_GRADE.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_EDGE_CONTRAST_MINIMUM +

Retrieves the minimum edge contrast of the scan reflectance profile.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the minimum edge contrast.

Collapse M_SCAN_EDGE_CONTRAST_MINIMUM_GRADE +

Retrieves the minimum edge contrast, as a grade.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_EDGE_DETERMINATION_GRADE +

Retrieves the edge determination, as a grade. The edge determination examines the number of bars and spaces in your code. Note that this grade is not considered when calculating the overall code grade (M_OVERALL_SYMBOL_GRADE), instead it is included in the decode grade (M_SCAN_DECODE_GRADE).

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_ERN_MAXIMUM +

Retrieves the highest ERN (element reflectance non-uniformity) in the scan reflectance profile. The ERN is an unexpected peak in the scan reflectance profile. The result is expressed as the ratio of the maximum ERN relative to the code (symbol) contrast (ERNmax /SC).

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the element reflectance non-uniformity maximum.

Collapse M_SCAN_GUARD_PATTERN +

Retrieves the size of the interior guard pattern, expressed as a factor of the cell (module size (Z)) in the scan reflectance profile. Guard patterns consist of two one-cell wide groupings at the end of each code. GS1 Databar code types have guard patterns at the ends of each row of the code. See the ISO 24724 specification. Note that the value is negative if the left guard pattern is greater than the right guard pattern, to permit easy identification.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D GS1 Databar code types and composite code types containing a GS1 Databar code.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_SCAN_GUARD_PATTERN_GRADE +

Retrieves the largest interior guard pattern, as a grade.

This result type is available for 1D GS1 Databar code types and composite code types containing a GS1 Databar code.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_INTERCHARACTER_GAP +

Retrieves the size of the largest intercharacter gap in the scan reflectance profile, expressed as a factor of the cell size (module size (Z)) in the scan reflectance profile. See ISO 16388 and AIM BC3-1995 for more details.

Note that this result type will always return the value of M_CODE_GRADE_NOT_AVAILABLE when McodeControl() with M_PIXEL_SIZE_IN_MM is not set, and the following condition is true:

(5.3 Z<= Largest intercharacter gap <= 3Z ).

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for Code 39 and Codabar code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse Value

Specifies the maximum intercharacter gap.

Collapse M_SCAN_INTERCHARACTER_GAP_GRADE +

Retrieves the largest intercharacter gap, as a grade.

This result type is available for Code 39 and Codabar code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies that the maximum intercharacter gap is under three times the module size (3Z).

Collapse M_CODE_GRADE_F

Specifies that the maximum intercharacter gap is over 5.3 times the module size (5.3Z).

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the maximum intercharacter gap cannot be calculated because the M_PIXEL_SIZE_IN_MM is not set.

Collapse M_SCAN_MODULATION +

Retrieves the modulation (MOD) of the scan reflectance profile. The modulation is the ratio of the minimum edge contrast (M_SCAN_EDGE_CONTRAST_MINIMUM) to the code (symbol) contrast (M_SCAN_SYMBOL_CONTRAST).

To retrieve the modulation of each codeword, use M_CODEWORD_MODULATION.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the modulation value.

Collapse M_SCAN_MODULATION_GRADE +

Retrieves the modulation (MOD) of the scan reflectance profile, as a grade.

To retrieve the modulation of each codeword as a grade, use M_CODEWORD_MODULATION_GRADE. To retrieve the modulation for the code as a grade, use M_MODULATION_GRADE.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_PRINT_CONTRAST_SIGNAL +

Retrieves the print contrast signal (PCS) of the scan reflectance profile. Note that this is an approximation based on the maximum reflectance (M_SCAN_REFLECTANCE_MAXIMUM) and the code (symbol) contrast (M_SCAN_SYMBOL_CONTRAST). For more details, see the ISO 15416 specification.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the print contrast signal.

Collapse M_SCAN_PROFILE_END_X +

Retrieves the X-coordinate of the end of the scan reflectance profile.

This result type relates to the position of the scan profiles, enabling you to visualize or draw the available analysis profiles using McodeDraw() with M_DRAW_SCAN_PROFILES. Note that the start and stop positions of any given scan are related to the steps of the analysis were performed.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_SCAN_PROFILE_END_Y +

Retrieves the Y-coordinate of the end of the scan reflectance profile.

This result type relates to the position of the scan profiles, enabling you to visualize or draw the available analysis profiles using McodeDraw() with M_DRAW_SCAN_PROFILES. Note that the start and stop positions of any given scan are related to the steps of the analysis were performed.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_SCAN_PROFILE_START_X +

Retrieves the X-coordinate of the start of the scan reflectance profile.

This result type relates to the position of the scan profiles, enabling you to visualize or draw the available analysis profiles using McodeDraw() with M_DRAW_SCAN_PROFILES. Note that the start and stop positions of any given scan are related to the steps of the analysis were performed.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_SCAN_PROFILE_START_Y +

Retrieves the Y-coordinate of the start of the scan reflectance profile.

This result type relates to the position of the scan profiles, enabling you to visualize or draw the available analysis profiles using McodeDraw() with M_DRAW_SCAN_PROFILES. Note that the start and stop positions of any given scan are related to the steps of the analysis were performed.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse M_SCAN_QUIET_ZONE +

Retrieves the ratio between the expected quiet zone of the theoretical code model and the measured quiet zone of your code as a ratio of ( measured quiet zone size / expected quiet zone size ).

The measurement is taken from both sides of the code. Note that if the returned value is negative, the left quiet zone is worse than the right. Refer to the appropriate specifications for more details (ISO 15417, ISO 15420, ISO 16388, and ISO 16390, respectively).

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D code types (except GS1 Databar) and composite code types encoded with a format of EAN/UPC or UCC/EAN120.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available.

Collapse Value

Specifies the scan quiet zone value.

Collapse M_SCAN_QUIET_ZONE_GRADE +

Retrieves the quiet zone size, as a grade.

This result type is available for 1D code types (except GS1 Databar) and composite code types encoded with a format of EAN/UPC or UCC/EAN120.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_REFLECTANCE_MAXIMUM +

Retrieves the highest reflectance (Rmax ) of the scan reflectance profile, as a percentage.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the maximum reflectance.

Collapse M_SCAN_REFLECTANCE_MINIMUM +

Retrieves the lowest reflectance (Rmin ) of the scan reflectance profile, as a percentage.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the minimum reflectance.

Collapse M_SCAN_REFLECTANCE_MINIMUM_GRADE +

Retrieves a pass or fail grade for the scan reflectance profile.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies that the scan reflectance profile passed.

Collapse M_CODE_GRADE_F

Specifies that the scan reflectance profile failed.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_REFLECTANCE_PROFILE_GRADE +

Retrieves the lowest grade from all the scan reflectance profile grading tests.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_REFLECTANCE_PROFILE_LENGTH +

Retrieves the number of values in the scan reflectance profile.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_SCAN_REFLECTANCE_PROFILE_VALUES +

Retrieves the reflectance values of the scan reflectance profile.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of values in the scan reflectance profile. This number can be obtained using McodeGetResult() with M_SCAN_REFLECTANCE_PROFILE_LENGTH.

Collapse M_SCAN_SYMBOL_CONTRAST +

Retrieves the code (symbol) contrast (SC) of the scan reflectance profile. Note that this value is used in conjunction with the maximum reflectance (M_SCAN_REFLECTANCE_MAXIMUM to determine the print contrast signal (M_SCAN_PRINT_CONTRAST_SIGNAL). For more details, see ISO 15416.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

When dealing with 2D matrix codes, to retrieve the code (symbol) contrast for the entire code, use M_SYMBOL_CONTRAST.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The sum of the length of the scan profiles. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse 0 <= Value <= 1

Specifies the code (symbol) contrast.

Collapse M_SCAN_SYMBOL_CONTRAST_GRADE +

Retrieves the code (symbol) contrast of the scan reflectance profile, as a grade.

This result type is available for 1D, 2D cross-row, and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SCAN_WIDE_TO_NARROW_RATIO +

Retrieves the ratio between the average of the widest and the average of the narrowest bar/space in the scan reflectance profile. See ISO 16388 and ISO 16390 for more details.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for Code 39, Codebar, Industrial 2/5, and Interleaved 2/5.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_SCAN_WIDE_TO_NARROW_RATIO_GRADE +

Retrieves wide to narrow ratio, as a grade.

This result type is available for Code 39, Codebar, Industrial 2/5, and Interleaved 2/5.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of scans. This number can be obtained using McodeGetResult() with M_NUMBER_OF_SCANS.

Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_START_STOP_PATTERN_GRADE +

Retrieves the average of the worst scan reflectance profile grades of each row, as a grade. A start/stop pattern is a set pattern that marks the end points of the code. For each scan reflectance profile, the start/stop pattern grade is computed for each graded row, then the average start/stop pattern grade for all the scan reflectance profiles is computed.

This result type is available for 2D cross-row and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_SYMBOL_CONTRAST +

Retrieves the code (symbol) contrast (SC) value for the code. In the case of matrix code types, the code (symbol) contrast is calculated as the average 10% of the lighter pixels minus the average 10% of the darker pixels.

To retrieve the code (symbol) contrast from scan reflectance profiles, use M_SCAN_SYMBOL_CONTRAST.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the code (symbol) contrast value.

Collapse M_SYMBOL_CONTRAST_GRADE +

Retrieves the code (symbol) contrast (SC) value for the code as a grade. The higher the contrast, the better it is for scanning purposes and the better the grade.

To retrieve the code (symbol) contrast of the scan reflectance profile as a grade, use M_SCAN_SYMBOL_CONTRAST_GRADE.

This result type is available for 2D matrix code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_UNUSED_ERROR_CORRECTION +

Retrieves the ratio of unused error correction to the total amount of error correction available for the code. This tests the extent to which regional or spot damage in the code has eroded the reading safety margin that error correction provides.

When dealing with results that are derived from other results, retrieve the results for the associated results first. For example, before retrieving M_SCAN_DEFECTS, retrieve M_SCAN_ERN_MAXIMUM and M_SCAN_SYMBOL_CONTRAST. This assists in narrowing down where your code (or potentially the configuration of your code context) is lacking.

This result type is available for all 2D and composite code types.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: array of type MIL_DOUBLE
Array size: The number of cells scanned. This number can be obtained using McodeGetResult() with M_CELL_NUMBER_X.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse 0 <= Value <= 1

Specifies the ratio of unused error correction within the code.

Collapse M_UNUSED_ERROR_CORRECTION_GRADE +

Retrieves the ratio of unused error correction to the total amount of error correction available for the code, as a grade.

This result type is available for all 2D and composite code types.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_VERSION_INFORMATION_1_GRADE +

Retrieves the readability of the version information in segment 1 of the code, as a grade. The version information is an embedded pattern used to identify the location of the error correction bits in the code.

This result type is only available for the QR code type.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_VERSION_INFORMATION_2_GRADE +

Retrieves the readability of the version information in segment 2 of the code, as a grade. The version information is an embedded pattern used to identify the location of the error correction bits in the code.

This result type is only available for the QR code type.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Collapse M_VERSION_INFORMATION_GRADE +

Retrieves the readability of the version information in the code, as a grade. The version information is an embedded pattern used to identify the location of the error correction bits in the code.

For QR codes version 1 through version 7, M_CODE_GRADE_NOT_AVAILABLE is returned.

This result type is only available for the QR code type.

(summarize)
Collapse M_CODE_GRADE_A

Specifies the best grade for the result.

Collapse M_CODE_GRADE_B

Specifies a good grade for the result.

Collapse M_CODE_GRADE_C

Specifies a fair grade for the result.

Collapse M_CODE_GRADE_D

Specifies a poor grade for the result.

Collapse M_CODE_GRADE_F

Specifies the worst grade for the result.

Collapse M_CODE_GRADE_NOT_AVAILABLE

Specifies that the result is not available for the code.

Combination constants for M_CODE_MODEL_ID; M_CODE_MODEL_INDEX; M_CODE_TYPE; M_CODEWORD_DECODABILITY; M_CODEWORD_DECODABILITY_GRADE; M_CODEWORD_DEFECTS; M_CODEWORD_DEFECTS_GRADE; M_CODEWORD_MODULATION; M_CODEWORD_MODULATION_GRADE; M_CODEWORD_YIELD; M_CODEWORD_YIELD_GRADE; M_DATA_CODEWORDS; M_DECODABILITY_GRADE; M_DECODE_GRADE; M_DEFECTS_GRADE; M_ENCODING; M_ERROR_CORRECTION; M_MODULATION_GRADE; M_NUMBER; M_NUMBER_OF_CODEWORDS; M_NUMBER_OF_DATA_CODEWORDS; M_NUMBER_OF_ERASURES; M_NUMBER_OF_ERROR_CORRECTION_CODEWORDS; M_NUMBER_OF_ERRORS; M_NUMBER_OF_ROWS; M_NUMBER_OF_SCANS; M_NUMBER_OF_SCANS_PER_ROW; M_OVERALL_SYMBOL_GRADE; M_ROW_OVERALL_GRADE; M_SCAN_DECODABILITY; M_SCAN_DECODABILITY_GRADE; M_SCAN_DECODE_GRADE; M_SCAN_DEFECTS; M_SCAN_DEFECTS_GRADE; M_SCAN_EDGE_CONTRAST_MINIMUM; M_SCAN_EDGE_CONTRAST_MINIMUM_GRADE; M_SCAN_EDGE_DETERMINATION_GRADE; M_SCAN_ERN_MAXIMUM; M_SCAN_GUARD_PATTERN; M_SCAN_GUARD_PATTERN_GRADE; M_SCAN_MODULATION; M_SCAN_MODULATION_GRADE; M_SCAN_PRINT_CONTRAST_SIGNAL; M_SCAN_PROFILE_END_X; M_SCAN_PROFILE_END_Y; M_SCAN_PROFILE_START_X; M_SCAN_PROFILE_START_Y; M_SCAN_QUIET_ZONE; M_SCAN_QUIET_ZONE_GRADE; M_SCAN_REFLECTANCE_MAXIMUM; M_SCAN_REFLECTANCE_MINIMUM; M_SCAN_REFLECTANCE_MINIMUM_GRADE; M_SCAN_REFLECTANCE_PROFILE_GRADE; M_SCAN_REFLECTANCE_PROFILE_LENGTH; M_SCAN_REFLECTANCE_PROFILE_VALUES; M_SCAN_SYMBOL_CONTRAST; M_SCAN_SYMBOL_CONTRAST_GRADE; M_START_STOP_PATTERN_GRADE; M_STATUS; M_TIMEOUT_END; M_UNUSED_ERROR_CORRECTION; M_UNUSED_ERROR_CORRECTION_GRADE.

You can add one of the following values to the above-mentioned values to determine the verification result of a composite code.

If neither of these combination constants is added to a result type, the 1D results are returned followed by the 2D part. Note that this does not include general results (number of rows, number of scanlines) where results are compounded into a single value.

function map Composite code verification results
CollapseCombination value Description
Collapse M_2D_COMPONENT

Retrieves the verification result of the 2D component of the composite code.

Collapse M_LINEAR_COMPONENT

Retrieves the verification result of the linear component of the composite code.

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

function map For specifying the data type
CollapseResultType Description
UserVarArrayPtr
- Possible values returned
Collapse M_TYPE_MIL_DOUBLE

Casts the requested results to a MIL_DOUBLE.

(summarize)
Collapse UserVarArrayPtr data type info
  • Data type: array of type MIL_DOUBLE
    Array size: Depends on the result type.
    Note: When multiple results.

  • Data type: MIL_DOUBLE
    Note: When a single result.

Collapse M_TYPE_MIL_INT

Casts the requested results to a MIL_INT.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: MIL_INT

Collapse M_TYPE_MIL_INT32

Casts the requested results to a MIL_INT32.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: MIL_INT32

Collapse M_TYPE_MIL_INT64

Casts the requested results to a MIL_INT64.

(summarize)
Collapse UserVarArrayPtr data type info

Data type: MIL_INT64

Collapse M_TYPE_TEXT_CHAR

Cast the requested results to a MIL_TEXT_CHAR.

(summarize)
Collapse UserVarArrayPtr data type info
  • Data type: MIL_TEXT_CHAR

  • Data type: array of type MIL_TEXT_CHAR
    Array size: Size depends on the contents of the array.

Compilation information
Header Include mil.h.
Library Use mil.lib; milcode.lib.
DLL Requires mil.dll; milcode.dll.
CODE MODEL ID CODE MODEL INDEX CODE TYPE 4 STATE AZTEC BC412 CODABAR CODE39 CODE93 CODE128 COMPOSITECODE DATAMATRIX EAN8 EAN13 EAN14 GS1 128 GS1 DATABAR INDUSTRIAL25 INTERLEAVED25 MAXICODE MICROPDF417 MICROQRCODE PDF417 PHARMACODE PLANET POSTNET QRCODE TRUNCATED PDF417 UPC A UPC E DATA CODEWORDS ENCODING ENC ALPHA ENC ALPHANUM ENC ALPHANUM PUNC ENC ASCII ENC AUSTRALIA MAIL C ENC AUSTRALIA MAIL N ENC AUSTRALIA MAIL RAW ENC AZTEC COMPACT ENC AZTEC FULL RANGE ENC AZTEC RUNE ENC EAN8 ENC EAN8 ADDON ENC EAN13 ENC EAN13 ADDON ENC GS1 128 MICROPDF417 ENC GS1 128 PDF417 ENC GS1 DATABAR EXPANDED ENC GS1 DATABAR EXPANDED STACKED ENC GS1 DATABAR LIMITED ENC GS1 DATABAR OMNI ENC GS1 DATABAR STACKED ENC GS1 DATABAR STACKED OMNI ENC GS1 DATABAR TRUNCATED ENC ISO8 ENC KOREA MAIL ENC MODE2 ENC MODE3 ENC MODE4 ENC MODE5 ENC MODE6 ENC NUM ENC QRCODE MODEL1 ENC QRCODE MODEL2 ENC STANDARD ENC UK MAIL ENC UPCA ENC UPCA ADDON ENC UPCE ENC UPCE ADDON ENC US MAIL ERROR CORRECTION ECC 4STATE ECC 200 ECC CHECK DIGIT ECC COMPOSITE ECC H ECC L ECC M ECC n ECC NONE ECC Q ECC REED SOLOMON ECC REED SOLOMON n ECC UNKNOWN EXTENDED AREA BOTTOM LEFT X EXTENDED AREA BOTTOM LEFT Y EXTENDED AREA BOTTOM RIGHT X EXTENDED AREA BOTTOM RIGHT Y EXTENDED AREA QUIET ZONE INCLUDED CODE GRADE NOT AVAILABLE FALSE TRUE EXTENDED AREA TOP LEFT X EXTENDED AREA TOP LEFT Y EXTENDED AREA TOP RIGHT X EXTENDED AREA TOP RIGHT Y IS GS1 FALSE TRUE NUMBER NUMBER OF CODEWORDS NUMBER OF DATA CODEWORDS NUMBER OF ERASURES NUMBER OF ERROR CORRECTION CODEWORDS NUMBER OF ERRORS QUIET ZONE BOTTOM LEFT X QUIET ZONE BOTTOM LEFT Y QUIET ZONE BOTTOM RIGHT X QUIET ZONE BOTTOM RIGHT Y QUIET ZONE INCLUDED FALSE TRUE QUIET ZONE TOP LEFT X QUIET ZONE TOP LEFT Y QUIET ZONE TOP RIGHT X QUIET ZONE TOP RIGHT Y STATUS STATUS CRC FAILED STATUS ECC UNKNOWN STATUS ENC UNKNOWN STATUS ENCODING ERROR STATUS GRADE FAILED STATUS GRADE OK STATUS NO RESULT AVAILABLE STATUS NOT FOUND STATUS READ OK STATUS TIMEOUT END TIMEOUT END FALSE TRUE ANGLE BOTTOM LEFT X BOTTOM LEFT Y BOTTOM RIGHT X BOTTOM RIGHT Y CELL NUMBER X CELL NUMBER Y CELL SIZE CODE FLIP FLIP NO FLIP FOREGROUND VALUE POSITION X POSITION Y SCORE SIZE X SIZE Y STRING STRING SIZE THRESHOLD MODE ADAPTIVE GLOBAL SEGMENTATION GLOBAL WITH LOCAL RESEGMENTATION THRESHOLD VALUE TOP LEFT X TOP LEFT Y TOP RIGHT X TOP RIGHT Y TOTAL STRING SIZE ESCAPE SEQUENCE APERTURE SIZE USED ASTERISK AXIAL NONUNIFORMITY CODE GRADE NOT AVAILABLE AXIAL NONUNIFORMITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CELL CONTRAST CODE GRADE NOT AVAILABLE CELL CONTRAST GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CELL MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CODEWORD DECODABILITY CODEWORD DECODABILITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CODEWORD DEFECTS CODEWORD DEFECTS GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CODEWORD MODULATION CODEWORD MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CODEWORD REFLECTANCE MARGIN CODEWORD REFLECTANCE MARGIN GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CODEWORD YIELD CODE GRADE NOT AVAILABLE CODEWORD YIELD GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE CONTRAST UNIFORMITY CODE GRADE NOT AVAILABLE CONTRAST UNIFORMITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE DECODABILITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE DECODE GRADE CODE GRADE A CODE GRADE F CODE GRADE NOT AVAILABLE DEFECTS GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE DOT SPACING USED EXTENDED AREA CODEWORD MODULATION EXTENDED AREA CODEWORD MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE A1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE A2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE A3 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE AVERAGE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE B1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE B2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE C GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE CLOCKTRACK SOLID GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE L1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE L2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE QZL1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA FIXED PATTERN DAMAGE QZL2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE EXTENDED AREA REFLECTANCE MAXIMUM EXTENDED AREA REFLECTANCE MINIMUM EXTENDED AREA SYMBOL CONTRAST EXTENDED AREA SYMBOL CONTRAST GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE A1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE A2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE A3 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE AVERAGE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE B1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE B2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE C GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE CLOCKTRACK SOLID GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE L1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE L2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE QZL1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FIXED PATTERN DAMAGE QZL2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FORMAT INFORMATION 1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FORMAT INFORMATION 2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE FORMAT INFORMATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE GRID NONUNIFORMITY CODE GRADE NOT AVAILABLE GRID NONUNIFORMITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE MEAN LIGHT CALIBRATION MEAN LIGHT TARGET MINIMUM REFLECTANCE CODE GRADE NOT AVAILABLE MINIMUM REFLECTANCE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE NUMBER OF ROWS NUMBER OF SCANS NUMBER OF SCANS PER ROW OVERALL SYMBOL GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE PRINT GROWTH CODE GRADE NOT AVAILABLE PRINT GROWTH GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE R MAX R MIN RECOMMENDED APERTURE SIZE REFLECTANCE CALIBRATION CODE GRADE NOT AVAILABLE REFLECTANCE MARGIN GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE ROW OVERALL GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN DECODABILITY SCAN DECODABILITY GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN DECODE GRADE CODE GRADE A CODE GRADE F CODE GRADE NOT AVAILABLE SCAN DEFECTS SCAN DEFECTS GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN EDGE CONTRAST MINIMUM SCAN EDGE CONTRAST MINIMUM GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN EDGE DETERMINATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN ERN MAXIMUM SCAN GUARD PATTERN SCAN GUARD PATTERN GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN INTERCHARACTER GAP CODE GRADE NOT AVAILABLE SCAN INTERCHARACTER GAP GRADE CODE GRADE A CODE GRADE F CODE GRADE NOT AVAILABLE SCAN MODULATION SCAN MODULATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN PRINT CONTRAST SIGNAL SCAN PROFILE END X SCAN PROFILE END Y SCAN PROFILE START X SCAN PROFILE START Y SCAN QUIET ZONE CODE GRADE NOT AVAILABLE SCAN QUIET ZONE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN REFLECTANCE MAXIMUM SCAN REFLECTANCE MINIMUM SCAN REFLECTANCE MINIMUM GRADE CODE GRADE A CODE GRADE F CODE GRADE NOT AVAILABLE SCAN REFLECTANCE PROFILE GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN REFLECTANCE PROFILE LENGTH SCAN REFLECTANCE PROFILE VALUES SCAN SYMBOL CONTRAST SCAN SYMBOL CONTRAST GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SCAN WIDE TO NARROW RATIO SCAN WIDE TO NARROW RATIO GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE START STOP PATTERN GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE SYMBOL CONTRAST CODE GRADE NOT AVAILABLE SYMBOL CONTRAST GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE UNUSED ERROR CORRECTION CODE GRADE NOT AVAILABLE UNUSED ERROR CORRECTION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE VERSION INFORMATION 1 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE VERSION INFORMATION 2 GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE VERSION INFORMATION GRADE CODE GRADE A CODE GRADE B CODE GRADE C CODE GRADE D CODE GRADE F CODE GRADE NOT AVAILABLE 2D COMPONENT LINEAR COMPONENT TYPE MIL DOUBLE TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 TYPE TEXT CHAR