MagmAllocResult

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 find or train AGM result buffer.

Syntax

AIL_ID MagmAllocResult(
    AIL_ID    SysId,          //in
    AIL_INT64 ResultType,     //in
    AIL_INT64 ControlFlag,    //in
    AIL_ID *  ResultAgmIdPtr  //out
)

Description

This function allocates a find or train AGM result buffer on the specified system. A find AGM result buffer stores results obtained from an MagmFind operation, while a train AGM result buffer stores results obtained from an MagmTrain operation.

When the AGM result buffer is no longer required, release it usingMagmFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the AGM 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.

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 AGM result buffer. This parameter must be set to one of the following values:

For the type of results buffer

Value	Description
M_GLOBAL_EDGE_BASED_FIND_RESULT	Specifies to allocate a find AGM result buffer. This result buffer holds the results produced from calling MagmFind.
M_GLOBAL_EDGE_BASED_TRAIN_RESULT	Specifies to allocate a train AGM result buffer. This result buffer holds the results produced from calling MagmTrain.

ControlFlag (in, AIL_INT64)

Reserved for future expansion. This parameter must be set to M_DEFAULT.

ResultAgmIdPtr *(out, AIL_ID)

Specifies the address of the variable in which to write the AGM result buffer identifier. Since the MagmAllocResultfunction also returns the AGM result buffer identifier, you can set this parameter to M_NULL.

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 AGM 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 AGM result buffer; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_AGM_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 AGM result buffer (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers.
Address in which to write the find AGM result buffer identifier	Specifies the address of an AIL_ID in which to write the identifier of the allocated find AGM result buffer.

If allocation fails, M_NULL is written as the identifier. | | Address in which to write the train AGM result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated train AGM result buffer.

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

Return Value

Type: AIL_ID

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