Filters
Filter values by
Operation Type
  • Code read operation
  • Code grade operation
    • Common to all
    • ISO grade (ISO/IEC 15416, ISO/IEC 15415)
    • ISO DPM grade (ISO/IEC TR 29158)
    • Semi T10 grade (Semi T10-0701)
  • Code detect operation
  • Code train operation
  • Code write operation
ResultIndex
  • Occurrence-specific results that can be retrieved for all code occurrences at once
  • General results
  • Occurrence-specific results
Scan line or row-specific result
  • Not scan or row specific result.
  • Results that can be retrieved for all scan lines or rows of the specified code occurrence(s) at once
  • Specific row result
  • Specific scan result
Code Type
  • 1D code types
  • 2D code types
    • Cross-row code types (PDF)
    • Matrix code types (Aztec, Data Matrix, Maxi, QR)
  • Composite code types
| Customize Help
| Save Settings

McodeGetResult



Function Map
Parameter Associations
Table: For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), McodeWrite() operation
Table: For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeTrain() operation
Table: For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation
Table: For retrieving general results from an McodeTrain() operation
Table: For retrieving code occurrence-specific results from McodeRead() or McodeGrade() or general results from an McodeTrain() operation
Table: For retrieving code occurrence-specific or code model-specific results from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation
Table: For retrieving code occurrence-specific results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation
Table: For retrieving code occurrence-specific results from an McodeRead(), McodeGrade(), or McodeWrite() operation
+ combination: For use with string result types
Table: For retrieving code occurrence-specific results from an McodeRead() or McodeGrade() operation
Table: For retrieving code occurrence-specific or code model-specific results from an McodeRead(), McodeGrade(), McodeTrain(), or McodeWrite() operation
Table: For retrieving code occurrence-specific or code model-specific results from an McodeRead(), McodeGrade(), or McodeTrain() operation
Table: For retrieving miscellaneous occurrence results from an McodeGrade() operation
Table: For retrieving row-specific results from an McodeRead() or McodeGrade() operation
Table: For retrieving row-specific results from an McodeGrade() operation
Table: For retrieving scan line-specific results from an McodeRead() or McodeGrade() operation
Table: For retrieving scan line-specific results from an McodeGrade() operation
+ combination: For retrieving the specified result for the 2D component of a composite code occurrence, from an McodeRead or McodeGrade operation
+ combination: For retrieving the specified result for the linear component (1D component) of a composite code occurrence, from an McodeGrade operation
Table: For retrieving code model-specific results from an McodeTrain() operation
Table: For retrieving information about the code context or code model control types that have been enabled to be trained using the McodeTrain() operation
+ combination: For determining the required array size (number of elements) to store the returned values
Table: For retrieving code occurrence-specific results from an McodeDetect() operation
Table: For retrieving code occurrence-specific results from an McodeWrite() operation
+ combination: For determining the string length
+ combination: For specifying the data type
Synopsis
Get the specified type of result for the specified code occurrence(s), or in the case of an McodeTrain() operation, for the specified code model(s), from a code result buffer.
Syntax
void McodeGetResult(
MIL_ID ResultCodeId, //in
MIL_INT ResultIndex, //in
MIL_INT RowOrScanIndex, //in
MIL_INT64 ResultType, //in
void *UserVarArrayPtr //out
)
Description

This function retrieves the result(s) of the specified type for the specified code occurrence(s), or in the case of an McodeTrain() operation, for the specified code model(s), from a code result buffer. For results from an McodeGrade() operation, you can also retrieve a result for a specific scan line or row of a specified code occurrence.

In some cases, you can also retrieve the specified result for all occurrences, or in the case of McodeTrain(), for all code models. The order in which these results are returned depends on the code operation that returned them. Use M_CODE_MODEL_ID to establish the corresponding code model of each returned result (or set of results for result types that return multiple values such as M_DATA_CODEWORDS). For more information on the order in which results are returned, see the Retrieving results section of Chapter 15: Codes.

The code operation must have been performed prior to calling McodeGetResult(); otherwise, an error will occur.

Besides code type restrictions listed explicitly in the result types below, keep in mind that McodeGrade() does not support M_4_STATE, M_PHARMACODE, M_POSTNET, and M_PLANET code types.

The results from an McodeTrain() operation are the recommended control type settings for a code context and its code models, based on the occurrences found in all the training images. To retrieve the results of the read operation that McodeTrain() internally performed on each training image, use M_CODE_RESULT_ID. This retrieves the identifiers of internal code read result buffers; there is one per training image. You can then pass McodeGetResult() one of these result buffer identifiers and retrieve any type of result available for an McodeRead() operation.

From an McodeGrade() operation, a resulting quality grade (such as, M_CONTRAST_UNIFORMITY_GRADE) is typically based on a calculation described in the standard selected using McodeControl() with M_GRADING_STANDARD. The calculation returns one result per codeword or one result per code occurrence, 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).

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 occurrence (or potentially the configuration of your code context) is lacking.

If your target image was associated with a camera 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 camera 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 McodeGetResult() in combination with McodeWrite() can be used to determine the required image buffer size to encode a given string. First, call McodeWrite() with ImageBufId set to M_NULL and then call McodeGetResult() to retrieve the minimum width (M_WRITE_SIZE_X) and height (M_WRITE_SIZE_Y) required to draw the code. For simplicity, the codes drawn using McodeWrite() are referred to as "code occurrences" in the ResultType tables below.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
ResultCodeId

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

ResultIndex

Specifies the code occurrence(s) or code model(s) for which to retrieve results.

function map For specifying the occurrence or model index
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default value.

For code occurrence-specific or code model-specific result types, this value is the same as M_ALL. For other result types, this value is the same as M_GENERAL.

(summarize)
Click to summarize M_ALL

Specifies to get results related to all code occurrences.

Note that when this value is used, results from an McodeRead(), McodeGrade(), McodeRead(), or McodeWrite() operation are returned in the order in which the code occurrences were found, regardless of the code model/code type.

(summarize)
Click to summarize M_GENERAL

Specifies to get general results related to all code occurrences, or in the case of McodeTrain(), the recommended control type settings for the code context.

Note that the order in which these results are returned depends on the code operation that returned them.

(summarize)
Click to summarize 0 <= CodeModelIndex < M_NUMBER_OF_CODE_MODELS

Specifies the index of the code model in the McodeTrain() result buffer from which to retrieve results. Code models are indexed in the result buffer in the same order as they were added to the training context. Use M_CODE_MODEL_ID to establish the corresponding code model identifier.

See the Retrieving results section of Chapter 15: Codes for more information on result indices.

(summarize)
Click to summarize 0 <= CodeOccurrenceIndex < M_NUMBER

Specifies the index of the code occurrence in the McodeRead(), McodeGrade(), or McodeDetect() result buffer from which to retrieve results. Code occurrences are indexed in the result buffer in the order in which they were found, regardless of the code model/code type. Use M_CODE_MODEL_ID and M_CODE_TYPE to establish the corresponding code model and code type, respectively.

See the Retrieving results section of Chapter 15: Codes for more information on result indices.

(summarize)
RowOrScanIndex

Specifies the scan line(s) or row(s) of the code occurrence in the McodeGrade() result buffer for which to retrieve results. For result types that are not scan line-specific or row-specific, set this parameter to M_GENERAL.

function map For specifying the scan line result index or row result index
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default value.

For a scan line-specific or row-specific result type, this value is the same as M_ALL. For other result types, this value is the same as M_GENERAL.

(summarize)
Click to summarize M_ALL

Specifies to retrieve the results related to all scan lines or rows of the specified code occurrence.

Click to summarize M_GENERAL

Specifies to retrieve general results.

Click to summarize 0 <= Value < M_NUMBER_OF_ROWS

Specifies the row for which to retrieve results of the specified code occurrence.

Note that this value cannot be used if ResultIndex is set to M_ALL or M_DEFAULT.

(summarize)
Click to summarize 0 <= Value < M_NUMBER_OF_SCANS

Specifies the scan line for which to retrieve results of the specified code occurrence.

Note that this value cannot be used if ResultIndex is set to M_ALL or M_DEFAULT.

(summarize)
ResultType

Specifies the type of result to retrieve.

Not all result types are available 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 [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ]
  • array of type MIL_ID [optionally, in C++: a reference to a std::vector<MIL_ID> ]
  • array of type MIL_INT [optionally, in C++: a reference to a std::vector<MIL_INT> ]
  • array of type MIL_INT32 [optionally, in C++: a reference to a std::vector<MIL_INT32> ]
  • array of type MIL_INT64 [optionally, in C++: a reference to a std::vector<MIL_INT64> ]
  • array of type MIL_TEXT_CHAR [optionally, in C++: a reference to a MIL_STRING]
  • MIL_DOUBLE
  • MIL_ID
  • 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 general result that is returned from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation, the ResultType parameter can be set to one of the following values.

Note that these result types require that ResultIndex be set to M_GENERAL.

function map For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), McodeWrite() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_STATUS +

Retrieves the status of the code operation that produced the results in the result buffer.

It can be helpful to retrieve the number of code occurrences by calling M_NUMBER, along with the status. For example, if you set an McodeRead() operation to read two code occurrences (McodeControl() with M_NUMBER) and only one was found, the status returned is M_STATUS_NOT_FOUND. Calling M_NUMBER will return 1.

If the operation that produced the results expected to operate on multiple code occurrences (McodeControl() with M_NUMBER) and it incurred an error for more than one, the least-common error is returned. For example, if you set an McodeRead() operation to read two code occurrences 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 an McodeRead() operation, use M_SCORE. To retrieve the confidence score of an McodeGrade() operation as a grade, use M_OVERALL_SYMBOL_GRADE.

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

Specifies that the McodeRead() operation failed when validating the CRC (only for an McodeRead() operation).

Click to summarize M_STATUS_DETECT_FAILED

Specifies that the McodeDetect() operation failed (only for an McodeDetect() operation).

Click to summarize M_STATUS_DETECT_OK

Specifies that the McodeDetect() operation was successful (only for an McodeDetect() operation).

Click to summarize M_STATUS_ECC_UNKNOWN

Specifies an unknown error correction type (only for an McodeRead() operation).

Click to summarize M_STATUS_ENC_UNKNOWN

Specifies an unknown encoding type (only for an McodeRead() operation).

Click to summarize M_STATUS_ENCODING_ERROR

Specifies that an error occurred when decoding the code (only for an McodeRead() operation).

Click to summarize M_STATUS_GRADE_FAILED

Specifies that the McodeGrade() operation failed (only for an McodeGrade() operation).

Click to summarize M_STATUS_GRADE_OK

Specifies that the McodeGrade() operation was successful (only for an McodeGrade() operation).

Click to summarize M_STATUS_NO_RESULT_AVAILABLE

Specifies that there are no results available (for an McodeRead() or McodeGrade() operation).

Click to summarize M_STATUS_NOT_FOUND

Specifies that the code was not found (only for an McodeRead() operation).

Click to summarize M_STATUS_READ_OK

Specifies that the McodeRead() operation was successful (only for an McodeRead() operation).

Click to summarize M_STATUS_TIMEOUT_END

Specifies that the code operation timed out.

Click to summarize M_STATUS_TRAIN_FAILED

Specifies that the McodeTrain() operation failed (only for an McodeTrain() operation).

Click to summarize M_STATUS_TRAIN_OK

Specifies that the McodeTrain() operation was successful (only for an McodeTrain() operation).

Click to summarize M_STATUS_WRITE_FAILED

Specifies that the McodeWrite() operation failed (only for an McodeWrite() operation).

Click to summarize M_STATUS_WRITE_OK

Specifies that the McodeWrite() operation was successful (only for an McodeWrite() operation).

To retrieve a general result that is returned from an McodeRead(), McodeGrade(), McodeDetect(), or McodeTrain() operation, the ResultType parameter can be set to one of the following values.

Note that these result types require that ResultIndex be set to M_GENERAL.

function map For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeTrain() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_TIMEOUT_END +

Retrieves whether the timeout limit was reached. You can set the timeout limit using McodeControl() with M_TIMEOUT or, in the case of an McodeTrain() operation, M_TRAIN_TIMEOUT.

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

Specifies that the timeout limit was not reached.

Click to summarize M_TRUE

Specifies that the timeout limit was reached.

To retrieve a general result that is returned from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation, the ResultType parameter can be set to one of the following values.

Note that these result types require that ResultIndex be set to M_GENERAL.

function map For retrieving general results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_NUMBER +

Retrieves the total number of code occurrences. Note that multiple occurrences of the same model are counted separately.

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

To retrieve a general result that is returned from an McodeTrain() operation, the ResultType parameter can be set to one of the following values.

Note that these result types require that ResultIndex be set to M_GENERAL.

function map For retrieving general results from an McodeTrain() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_CODE_RESULT_ID +

Retrieves the identifiers of the internal code read result buffers associated with the training images; there is one result buffer per training image. Each identifier can be used to retrieve the results of the read operation that McodeTrain() internally performed on the corresponding training image.

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

Retrieves the identifiers of the training images that have been unsuccessfully read.

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

Retrieves the indices of the training images that have been unsuccessfully read.

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

Retrieves the number of images that have been unsuccessfully read.

(summarize)
Expand data type infoCollapse data type info UserVarArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_NUMBER_OF_CODE_MODELS +

Retrieves the number of code models added to the training context.

(summarize)
Expand data type infoCollapse data type info UserVarArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_NUMBER_OF_TRAINING_IMAGES +

Retrieves the number of images used in the current train operation.

(summarize)
Expand data type infoCollapse data type info UserVarArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_PASSED_IMAGES_ID +

Retrieves the identifiers of the training images that have been successfully read.

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

Retrieves the indices of the training images that have been successfully read.

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

Retrieves the number of images that have been successfully read.

(summarize)
Expand data type infoCollapse data type info UserVarArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE MORE
Click to summarize M_SEARCH_ANGLE_MODE +

Retrieves the recommended setting for whether to enable the search angular range algorithm (McodeControl() with M_SEARCH_ANGLE_MODE) for the code context.

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

Specifies that the search angular range algorithm is used.

Click to summarize M_TRAIN

Specifies that the corresponding control type was not trained since M_SEARCH_ANGLE was not selected for training; alternatively, it means that the corresponding control type does not apply to the code model(s).

Click to summarize M_SPEED +

Retrieves the recommended setting for the search speed (McodeControl() with M_SPEED) for the code context.

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

Specifies a low search speed.

Click to summarize M_MEDIUM

Specifies a medium search speed.

Click to summarize M_TRAIN

Specifies that the corresponding control type was not selected for training or does not apply to the code model(s).

Click to summarize M_VERY_LOW

Specifies a very low search speed.

Click to summarize M_TRAIN_ENABLED_NUMBER_OF_MODEL_CONTROL_TYPES +

Retrieves the number of code model control types that have been enabled to be trained.

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

Retrieves the number of code model control types that can be modified by the training results; that is, the code model control types that will be changed after calling  McodeControl() with M_RESET_FROM_TRAINED_RESULTS.

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

Retrieves the percentage of successful internal McodeRead() operations. The percentage is obtained by dividing the number of successfully-read images by the total number of images used.

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

To retrieve a code occurrence-specific result that, when obtained from an McodeRead() or McodeGrade() operation, requires ResultIndex to be set to a specific occurrence or M_ALL (or M_DEFAULT); whereas, when obtained from an McodeTrain() operation requires ResultIndex to be set to M_GENERAL.

function map For retrieving code occurrence-specific results from McodeRead() or McodeGrade() or general results from an McodeTrain() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_CODE_MODEL_ID +

Retrieves the identifier of the code model of the code occurrence; alternatively, for results from an McodeTrain() operation, it retrieves the identifier of the trained code model. Note that this result is not valid when the result buffer is on a remote system. To find out which code model was used when the result buffer is on a remote system, use M_CODE_MODEL_INDEX instead.

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

Retrieves the threshold mode used to internally binarize the source image of an McodeRead() or McodeGrade() operation for the specified code occurrence(s); alternatively, for results from an McodeTrain() operation, it retrieves the recommended threshold mode setting (McodeControl() with M_THRESHOLD_MODE) for the code context.

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

Specifies the use of a fast dynamic local threshold.

Click to summarize M_GLOBAL_SEGMENTATION

Specifies the use of a global threshold value.

Click to summarize M_GLOBAL_WITH_LOCAL_RESEGMENTATION

Specifies that the source image was be globally thresholded and then the edges in the binarized image were resegmented according to the intensities of the surrounding bars and spaces in the original source image.

Click to summarize M_TRAIN

Specifies that the corresponding control type was not selected for training or does not apply to the code context. Note that this value will only be returned after an McodeTrain() operation, if applicable.

(summarize)
Click to summarize M_THRESHOLD_VALUE +

Retrieves the threshold value used to internally binarize the source image of an McodeRead() or McodeGrade() operation for the specified code occurrence(s); alternatively, for results from an McodeTrain() operation, it retrieves the recommended threshold value setting (McodeControl() with M_THRESHOLD_VALUE) for the code context.

Note that, this result type is only available when M_THRESHOLD_MODE is not set to M_ADAPTIVE.

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

Specifies to calculate the threshold value automatically. Note that this value will only be returned after an McodeTrain() operation, if applicable.

(summarize)
Click to summarize M_TRAIN

Specifies that the corresponding control type was not trained since M_THRESHOLD_MODE was not selected for training; alternatively, it means that the corresponding control type does not apply to the code context. Note that this value will only be returned after an McodeTrain() operation, if applicable.

(summarize)
Click to summarize 0 <= Value <= 255

Specifies the threshold value.

To retrieve a code occurrence-specific or code model-specific result that is returned from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation, the ResultType parameter can be set to the following value. In this case, the ResultIndex parameter must be set to the index of a specific occurrence or M_ALL (or M_DEFAULT).

function map For retrieving code occurrence-specific or code model-specific results from an McodeRead(), McodeGrade(), McodeDetect(), McodeTrain(), or McodeWrite() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_CODE_TYPE +

Retrieves the code type of the specified code occurrence(s). The code type is retrieved as a numeric that can be passed to McodeModel(). After an McodeDetect() operation, you can retrieve the code type's corresponding name using McodeGetResult() with M_CODE_TYPE_NAME.

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

Specifies a 4-state code type.

Click to summarize M_AZTEC

Specifies an Aztec code type.

Click to summarize M_BC412

Specifies a BC412 code type.

Click to summarize M_CODABAR

Specifies a Codabar code type.

Click to summarize M_CODE39

Specifies a Code 39 code type.

Click to summarize M_CODE93

Specifies a Code 93 code type.

Click to summarize M_CODE128

Specifies a Code 128 code type.

Click to summarize M_COMPOSITECODE

Specifies a composite code type.

Click to summarize M_DATAMATRIX

Specifies a Data Matrix code type.

Click to summarize M_EAN8

Specifies an EAN 8 code type.

Click to summarize M_EAN13

Specifies an EAN 13 code type.

Click to summarize M_EAN14

Specifies an EAN 14 code type.

Click to summarize M_GS1_128

Specifies a GS1-128 code type.

Click to summarize M_GS1_DATABAR

Specifies a GS1 Databar code type.

Click to summarize M_INDUSTRIAL25

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

Click to summarize M_INTERLEAVED25

Specifies an Interleaved 2 of 5 (ITF-14) code type.

Click to summarize M_MAXICODE

Specifies a Maxicode code type.

Click to summarize M_MICROPDF417

Specifies a MicroPDF417 code type.

Click to summarize M_MICROQRCODE

Specifies a Micro QR code type.

Click to summarize M_PDF417

Specifies a PDF417 code type.

Click to summarize M_PHARMACODE

Specifies a Pharmacode code type.

Click to summarize M_PLANET

Specifies a Planet code type.

Click to summarize M_POSTNET

Specifies a Postnet code type.

Click to summarize M_QRCODE

Specifies a QR code type.

Click to summarize M_TRUNCATED_PDF417

Specifies a Truncated PDF417 code type.

Click to summarize M_UPC_A

Specifies a UPC-A code type.

Click to summarize M_UPC_E

Specifies a UPC-E code type.

Click to summarize M_ENCODING +

Retrieves the type of encoding of the specified code occurrence(s).

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 Omnidirectional 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)
Expand data type infoCollapse data type info UserVarArrayPtr extra info
Data type info: Data type: address of a MIL_DOUBLE  |  array of type MIL_DOUBLE [optionally, in C++: a reference to a std::vector<MIL_DOUBLE> ] MORE
Click to summarize M_ANY

Specifies any type of encoding scheme. Note that this value will only be returned after an McodeTrain() operation, if applicable.

(summarize)
Click to summarize M_ENC_ALPHA

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

Click to summarize M_ENC_ALPHANUM

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

Click to summarize M_ENC_ALPHANUM_PUNC

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

Click to summarize M_ENC_ASCII

Specifies an encoding scheme that supports ASCII characters.

Click to summarize M_ENC_AUSTRALIA_MAIL_C

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

Click to summarize M_ENC_AUSTRALIA_MAIL_N

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

Click to summarize M_ENC_AUSTRALIA_MAIL_RAW

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

Click to summarize M_ENC_AZTEC_COMPACT

Specifies an encoding scheme for a compact Aztec code.

Click to summarize M_ENC_AZTEC_FULL_RANGE

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

Click to summarize M_ENC_AZTEC_RUNE

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

Click to summarize M_ENC_EAN8

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

Click to summarize M_ENC_EAN8_ADDON

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

Click to summarize M_ENC_EAN13

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

Click to summarize M_ENC_EAN13_ADDON

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

Click to summarize M_ENC_GS1_128_MICROPDF417

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

Click to summarize M_ENC_GS1_128_PDF417

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

Click to summarize M_ENC_GS1_DATABAR_EXPANDED

Specifies an encoding scheme that uses a GS1 Databar format.

Click to summarize M_ENC_GS1_DATABAR_EXPANDED_STACKED

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

Click to summarize M_ENC_GS1_DATABAR_LIMITED

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

Click to summarize M_ENC_GS1_DATABAR_OMNI

Specifies an encoding scheme that uses a GS1 Databar format.

Click to summarize M_ENC_GS1_DATABAR_STACKED

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

Click to summarize M_ENC_GS1_DATABAR_STACKED_OMNI

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

Click to summarize M_ENC_GS1_DATABAR_TRUNCATED

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

Click to summarize M_ENC_ISO8

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

Click to summarize M_ENC_KOREA_MAIL

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

Click to summarize M_ENC_MODE2

Specifies an encoding scheme that requires a Structured Carrier Message.

Click to summarize M_ENC_MODE3

Specifies an encoding scheme that requires a Structured Carrier Message.

Click to summarize M_ENC_MODE4

Specifies an encoding scheme that requires a Free Format Message.

Click to summarize M_ENC_MODE5

Specifies an encoding scheme that requires a Free Format Message.

Click to summarize M_ENC_MODE6

Specifies an encoding scheme that requires a Free Format Message.

Click to summarize M_ENC_NUM

Specifies an encoding scheme that only supports numbers.

Click to summarize M_ENC_QRCODE_MODEL1

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

Click to summarize M_ENC_QRCODE_MODEL2

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

Click to summarize M_ENC_STANDARD

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

Click to summarize M_ENC_UK_MAIL

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

Click to summarize M_ENC_UPCA

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

Click to summarize M_ENC_UPCA_ADDON

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

Click to summarize M_ENC_UPCE

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

Click to summarize M_ENC_UPCE_ADDON

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

Click to summarize M_ENC_US_MAIL

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

Click to summarize 5 <= Value <= 95

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

To retrieve a code occurrence-specific result that is returned from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation, the ResultType parameter can be set to one of the following values. In this case, the ResultIndex parameter must be set to the index of a specific occurrence or M_ALL (or M_DEFAULT).

function map For retrieving code occurrence-specific results from an McodeRead(), McodeGrade(), McodeDetect(), or McodeWrite() operation
Click to summarize
ResultType
Description
UserVarArrayPtr
- Possible values returned
Click to summarize M_BOTTOM_LEFT_X +

Retrieves the X-coordinate of the bottom-left corner of the specified code occurrence(s).

For an occurrence of a 1D code type from an McodeRead() operation, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

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

Retrieves the Y-coordinate of the bottom-left corner of the specified code occurrence(s).

For an occurrence of a 1D code type from an McodeRead() operation, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

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

Retrieves the X-coordinate of the bottom-right corner of the specified code occurrence(s).

For an occurrence of a 1D code type from an McodeRead() operation, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

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

Retrieves the Y-coordinate of the bottom-right corner of the specified code occurrence(s).

For an occurrence of a 1D code type from an McodeRead() operation, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

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

Retrieves the X-coordinate of the top-left corner of the specified code occurrence(s).

For an occurrence of a 1D code type from an McodeRead() operation, this value is dependent on McodeControl() with M_POSITION_ACCURACY.

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