MmodAllocResult

Filters
See also

User Guide:

Retrieving and analyzing results Steps to performing a model search

Reference:

MmodAlloc MmodFind MmodFree MsysAlloc

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/GPm

Available on Matrox Supersight

Function map

Examples

Function Map

- SystemId

Table:

For specifying the system identifier

- ControlFlag

Table:

For specifying the type of Model Finder result buffer

- ModResultIdPtr

Return value

Compilation information

Synopsis

Allocate a Model Finder result buffer.

Syntax

MIL_ID MmodAllocResult(

MIL_ID SystemId,	//in
MIL_INT64 ControlFlag,	//in
MIL_ID *ModResultIdPtr	//out

)

Description

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

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:

For specifying the system identifier
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ControlFlag

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

For specifying the type of Model Finder result buffer
Value	Description
M_DEFAULT	Specifies that the Model Finder result buffer can hold results from a search with an M_GEOMETRIC or M_GEOMETRIC_CONTROLLED type of context.
M_SHAPE_CIRCLE	Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_CIRCLE type of context.
M_SHAPE_ELLIPSE	Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_ELLIPSE type of context.

ModResultIdPtr

Specifies the address of the variable in which to write the Model Finder result buffer identifier. Since the MmodAllocResult() function also returns the model result buffer 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; milmod.lib.
DLL	Requires mil.dll; milmod.dll.