Click here to show toolbars of the Web Online Help System: show toolbars
 

| Customize Help
| Save Settings

MpatAllocResult


Function Map
Syntax
Description
Parameters
- SysId
Table: For the system identifier
- ControlFlag
- ResultPatIdPtr
Return value
Compilation information
Synopsis
Allocate a Pattern Matching result buffer.
Syntax
MIL_ID MpatAllocResult(
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ResultPatIdPtr //out
)
Description

This function allocates a Pattern Matching result buffer, on the specified system, to store results obtained from an MpatFind() operation. 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
SysId 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
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

Reserved for future expansion and must be set to M_DEFAULT.

ResultPatIdPtr

Specifies the address of the variable in which to write the Pattern Matching result buffer identifier. Since the MpatAllocResult() function also returns the Pattern Matching 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; milpat.lib.
DLL Requires mil.dll; milpat.dll.
DEFAULT HOST