| Customize Help
| Save Settings

McodeAllocResult



Function Map
Synopsis
Allocate a code result buffer.
Syntax
MIL_ID McodeAllocResult(
MIL_ID SysId, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ResultCodeIdPtr //out
)
Description

This function allocates a code result buffer on the specified system to store results obtained from an McodeTrain(), McodeDetect() McodeRead(), McodeGrade(), or McodeWrite() operation. When the result buffer is no longer required, release it, using McodeFree().

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
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 specifying the system
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

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

function map For specifying the result buffer type
Click to summarizeValue Description
Click to summarize M_DEFAULT

Same as M_CODE_GRADE_RESULT.

Click to summarize M_CODE_DETECT_RESULT

Specifies to allocate a code detect result buffer to be used with McodeDetect().

Click to summarize M_CODE_GRADE_RESULT

Specifies to allocate a code grade result buffer to be used with McodeGrade().

Click to summarize M_CODE_READ_RESULT

Specifies to allocate a code read result buffer to be used with McodeRead().

Click to summarize M_CODE_TRAIN_RESULT

Specifies to allocate a code train result buffer to be used with McodeTrain().

Click to summarize M_CODE_WRITE_RESULT

Specifies to allocate a code write result buffer to be used with McodeWrite().

ResultCodeIdPtr

Specifies the address of the variable in which to write the code result buffer identifier. Since the McodeAllocResult() function also returns the 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; milcode.lib.
DLL Requires mil.dll; milcode.dll.
DEFAULT HOST DEFAULT CODE DETECT RESULT CODE GRADE RESULT CODE READ RESULT CODE TRAIN RESULT CODE WRITE RESULT