| Customize Help
| Save Settings

MmodAllocResult



Function Map
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 which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
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
Click to summarizeValue Description
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

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

ControlFlag INQ

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

function map For specifying the type of Model Finder result buffer
Click to summarizeValue Description
Click to summarize 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.

Click to summarize M_SHAPE_CIRCLE

Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_CIRCLE type of context.

Click to summarize M_SHAPE_ELLIPSE

Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_ELLIPSE type of context.

Click to summarize M_SHAPE_RECTANGLE

Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_RECTANGLE type of context.

Click to summarize M_SHAPE_SEGMENT

Specifies that the Model Finder result buffer can hold results from a search with an M_SHAPE_SEGMENT 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.
DEFAULT HOST DEFAULT SHAPE CIRCLE SHAPE ELLIPSE SHAPE RECTANGLE SHAPE SEGMENT