M3ddispAllocResult
| 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 picking result buffer.
Syntax
AIL_ID M3ddispAllocResult(
AIL_ID SysId, //in
AIL_INT64 ResultType, //in
AIL_INT64 ControlFlag, //in
AIL_ID * Result3ddispIdPtr //out
)
Description
This function allocates a picking result buffer on the specified system, to store results from an M3ddispPick or M3ddispPickRect operation.
After allocating the picking result buffer, you should check if the operation was successful, using MappGetError or by verifying that the picking result buffer identifier returned is not M_NULL (or nullptr ifM_UNIQUE_ID was specified).
When the picking result buffer is no longer required, release it usingM3ddispFreeunless M_UNIQUE_ID was specified during allocation; if M_UNIQUE_ID was specified, the smart identifier manages the picking result buffer's lifetime and you must not manually free it.
Parameters
SysId (in, AIL_ID)
Specifies the system on which to allocate the picking result buffer. This parameter should be set to one of the following values:
For specifying the system
| Value | Description |
|---|---|
M_DEFAULT_HOST | Specifies the default Host system of the current Aurora Imaging Libraryapplication. |
System identifier | Specifies a valid system identifier, previously allocated using MsysAlloc. |
ResultType (in, AIL_INT64)
Specifies the type of result buffer to allocate.
For specifying the type of result buffer
| Value | Description |
|---|---|
M_PICKING_AREA_RESULT | Specifies to allocate a picking area result buffer. |
M_PICKING_RESULT | Specifies to allocate a picking result buffer. |
ControlFlag (in, AIL_INT64)
Reserved for future expansion and must be set to M_DEFAULT.
Result3ddispIdPtr *(out, AIL_ID)
Specifies the address of the variable in which to write the picking result buffer identifier or specifies the data type that the function should use to return the picking 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 picking 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 picking result buffer; in this case, an Aurora Imaging Library smart identifier of type _AIL_UNIQUE_3DDISP_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 picking result buffer (it is freed automatically). For more information, see Aurora Imaging Library smart identifiers. |
Address in which to write the picking area result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated picking area result buffer. |
If allocation fails, M_NULL is written as the identifier. |
| Address in which to write the picking result buffer identifier | Specifies the address of an AIL_ID in which to write the identifier of the allocated picking result buffer.
If allocation fails, M_NULL is written as the identifier. |
Return Value
Type: AIL_ID
The returned value is the picking result buffer identifier either as a standard identifier (AIL_ID) or a smart identifier (AIL_UNIQUE_3DDISP_ID). If allocation fails, M_NULL is returned (or nullptr ifM_UNIQUE_ID was specified).