| Customize Help
| Save Settings

MclassAllocResult


Function Map
Syntax
Description
Parameters
- SysId
Table: For specifying the system identifier
- ResultType
Table: For specifying the type of classification result buffer to allocate
- ControlFlag
- ResultClassIdPtr
Return value
Compilation information
Synopsis
Allocate a classification result buffer to hold training or prediction results.
Syntax
MIL_ID MclassAllocResult(
MIL_ID SysId, //in
MIL_INT64 ResultType, //in
MIL_INT64 ControlFlag, //in
MIL_ID *ResultClassIdPtr //out
)
Description

This function allocates a classification result buffer, on the specified system, to store the results from an MclassTrain() or MclassPredict() operation. When the result buffer is no longer required, release its memory, using MclassFree().

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

Specifies the identifier of 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().
ResultType

Specifies the type of classification result buffer to allocate. Set this parameter to one of the following values:

function map For specifying the type of classification result buffer to allocate
Click to summarizeValue Description
Click to summarize M_PREDICT_CNN_RESULT

Specifies to allocate a CNN prediction result buffer. This buffer holds the results produced from calling MclassPredict() with a predefined CNN classifier context (M_CLASSIFIER_CNN_PREDEFINED).

(summarize)
Click to summarize M_PREDICT_TREE_ENSEMBLE_RESULT

Specifies to allocate a tree ensemble prediction result buffer. This buffer holds the results produced from calling MclassPredict() with a tree ensemble classifier context (M_CLASSIFIER_TREE_ENSEMBLE).

(summarize)
Click to summarize M_TRAIN_CNN_RESULT

Specifies to allocate a CNN training result buffer. This buffer holds the results produced from calling MclassTrain() with a CNN training context (M_TRAIN_CNN).

(summarize)
Click to summarize M_TRAIN_TREE_ENSEMBLE_RESULT

Specifies to allocate a tree ensemble training result buffer. This buffer holds the results produced from calling MclassTrain() with a tree ensemble training context (M_TRAIN_TREE_ENSEMBLE).

(summarize)
ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

ResultClassIdPtr

Specifies the address of the variable in which to write the classification result buffer identifier. Since MclassAllocResult() also returns the classification result identifier, you can set this parameter to M_NULL.

Return value
The returned value is the classification result buffer's identifier if the allocation is successful. If allocation fails, M_NULL is returned.
Compilation information
Header Include mil.h.
Library Use mil.lib; milclass.lib.
DLL Requires mil.dll; milclass.dll.
DEFAULT HOST PREDICT CNN RESULT PREDICT TREE ENSEMBLE RESULT TRAIN CNN RESULT TRAIN TREE ENSEMBLE RESULT