MregAllocResult

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

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:

For specifying the system
Value	Description
M_DEFAULT_HOST	Specifies the default Host system of the current MIL application.
MIL system identifier	Specifies a valid system identifier, previously allocated using MsysAlloc().

ControlFlag

Specifies the type of result buffer to allocate. This parameter should be set to one of the following values.

For specifying the type of result buffer
Value	Description
M_DEFAULT	Same as M_STITCHING_RESULT.
M_EXTENDED_DEPTH_OF_FIELD_RESULT	Specifies that the result buffer can hold results from an extended depth of field (EDoF) operation.
M_STITCHING_RESULT	Specifies that the result buffer can hold results from a correlation-stitching registration operation.

ResultIdPtr

Specifies the address of the variable in which to write the registration result buffer identifier. Since MregAllocResult() also returns the registration 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; milreg.lib.
DLL	Requires mil.dll; milreg.dll.