| MIL 10 Reference
| Customize Help
| Save Settings

MpatAllocResult


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
MpatAllocModel
MpatAllocRotatedModel
Synopsis
Allocate a pattern matching result buffer.
Syntax
MIL_ID MpatAllocResult(
MIL_ID SystemId, //in
MIL_INT NbEntries, //in
MIL_ID *PatResultIdPtr //out
)
Description

This function allocates a result buffer with the specified number of entries. When the result buffer is no longer required, release its memory, using MpatFree().

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 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().
NbEntries INQ

Specifies the number of result entries to allocate. If NbEntries is set to M_DEFAULT, the number of entries will be allocated dynamically to match the number of actual occurrences found at runtime; used in conjunction with an M_ALL search (MpatSetNumber()), this provides an efficient method of allocating the correct size result buffer.

This parameter must be set to one of the values below.

function map For specifying the number of result entries
CollapseValue Description
Collapse M_DEFAULT

Specifies that the number of entries will be allocated dynamically to match the number of actual occurrences found at runtime.
Collapse Value

Specifies the number of result entries to allocate. Value should be greater than or equal to the number of occurrences specified with MpatSetNumber().

(summarize)
PatResultIdPtr

Specifies the address of the variable in which the pattern matching result buffer identifier is to be written. Since the MpatAllocResult() function also returns the pattern matching result buffer identifier, you can set this parameter to M_NULL. If allocation fails, M_NULL is written as the identifier.

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; milpat.lib.
DLL Requires mil.dll; milpat.dll.
DEFAULT HOST DEFAULT