| MIL 10 Reference
| Customize Help
| Save Settings

MstrAllocResult


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
MstrAlloc
MstrControl
Synopsis
Allocate a String Reader result buffer.
Syntax
MIL_ID MstrAllocResult(
MIL_ID SystemId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ObjectIdPtr //out
)
Description

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

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 String Reader result buffer.

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

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

Reserved for future expansion and must be set to M_DEFAULT.

ObjectIdPtr

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