| MIL 10 Reference
| Customize Help
| Save Settings

MmetAllocResult


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
MmetAlloc
MmetCalculate
Synopsis
Allocate a metrology result buffer.
Syntax
MIL_ID MmetAllocResult(
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ResultIdPtr //out
)
Description

This function allocates a metrology result buffer, on the specified system, to store results obtained from an MmetCalculate() operation. When the metrology result buffer is no longer required, release its memory, using MmetFree().

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
SysId

Specifies the system on which to allocate the metrology result buffer.

This parameter should be set to one of the following values:

function map For specifying the system
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().
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ResultIdPtr

Specifies the address of the variable in which to write the metrology result buffer identifier. Since the MmetAllocResult() function also returns the metrology result buffer identifier, you can set this parameter to M_NULL.

Return value
The returned value is the metrology 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; milmetrol.lib.
DLL Requires mil.dll; milmetrol.dll.
DEFAULT HOST