McolAllocResult

Board	Supported
Host System	Yes
V4L2	Yes
Clarity UHD	Yes
Concord PoE	No
GenTL	Yes
GevIQ	Yes
GigE Vision	Yes
Indio	No
Iris GTX	Yes
Radient eV-CL	Yes
Rapixo CL	Yes
Rapixo CoF	Yes
Rapixo CXP	Yes
USB3 Vision	Yes

Allocate a color matching result buffer.

Syntax

AIL_ID McolAllocResult(
    AIL_ID    SysId,        //in
    AIL_INT64 ResultType,   //in
    AIL_INT64 ControlFlag,  //in
    AIL_ID *  ResultIdPtr   //out
)

Description

This function allocates a result buffer, on the specified system, to store the results from an McolMatch operation. You can read the results from the result buffer, using McolGetResult.

When the color matching result buffer is no longer required, release it usingMcolFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the color matching result buffer's lifetime and you must not manually free it.

Parameters

SysId (in, AIL_ID)

Specifies the system on which to allocate the result buffer. This parameter should be set to one of the following values:

For specifying the system identifier

Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current Aurora Imaging Library application.
System identifier	Specifies a valid system identifier, previously allocated using MsysAlloc.

ResultType (in, AIL_INT64)

Specifies the type of result buffer to allocate. This parameter can be set to one of the following values:

For specifying the type of result buffer to allocate

Value	Description
M_DEFAULT	Same as M_COLOR_MATCHING_RESULT.
M_COLOR_MATCHING_RESULT	Specifies to allocate a result buffer for color matching results.

ControlFlag (in, AIL_INT64)

Reserved for future expansion and must be set to M_DEFAULT.

ResultIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the color matching result buffer identifier or specifies the data type that the function should use to return the color matching result buffer identifier.

For retrieving the identifier or specifying how to return it

Value	Description
M_NULL	Specifies that you will use this function's return value to obtain the identifier of the allocated color matching result

                          buffer; in this case, a standard Aurora Imaging Library identifier of type _AIL_ID_ is returned. |

| M_UNIQUE_ID | Specifies that you will use this function's return value to obtain the identifier of the allocated color matching result buffer; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_COL_ID_is returned instead of a standard Aurora Imaging Library identifier.This setting is only available when using C++11 (or later).An Aurora Imaging Library smart identifier manages the lifespan of the Aurora Imaging Library object it owns (similar to a std::unique_ptr). Note, you can use an Aurora Imaging Library smart identifier as though it were a standard Aurora Imaging Library identifier, except that you cannot use it to manually free the color matching result buffer (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers. | | Address for the result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated color matching result buffer.

If allocation fails, M_NULL is written as the identifier. |

Return Value

Type: AIL_ID

The returned value is the color matching result buffer identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_COL_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).