| MIL 10 Reference
| Customize Help
| Save Settings

McolAllocResult



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
Allocate a color matching result buffer.
Syntax
MIL_ID McolAllocResult(
MIL_ID SystemId, //in
MIL_INT64 ResultType, //in
MIL_INT64 ControlFlag, //in
MIL_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 result buffer is no longer required, release its memory, using McolFree().

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
SystemId INQ

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

function map For specifying the system identifier
CollapseValue Description
Collapse M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Collapse MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

ResultType

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

function map For specifying the type of result buffer to allocate
CollapseValue Description
Collapse M_DEFAULT

Same as M_COLOR_MATCHING_RESULT.

Collapse M_COLOR_MATCHING_RESULT

Specifies to allocate a result buffer for color matching results.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ResultIdPtr

Specifies the address of the variable in which to write the color matching result identifier. If allocation fails, M_NULL is returned as the identifier. Since McolAllocResult() also returns the color matching result identifier, you can set this parameter to M_NULL.

Return value
The returned value is the result buffer identifier if the allocation is successful. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milcolor.lib.
DLL Requires mil.dll; milcolor.dll.
DEFAULT HOST DEFAULT COLOR MATCHING RESULT