| Customize Help
| Save Settings

MfpgaCommandFree



Function Map
Synopsis
Free an FPGA command context.
Syntax
MIL_INT MfpgaCommandFree(
MIL_FPGA_CONTEXT FpgaCommandContext, //in
MIL_INT64 ControlFlag //in
)
Description

This function deallocates a previously allocated FPGA command context. The FPGA command context should be freed after an MfpgaCommandQueue() is issued. The processing operation that is associated with the command context, will complete its operation even if MfpgaCommandFree() is executed before processing is finished.

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
FpgaCommandContext

Specifies the handle of the FPGA command context to deallocate. The command context must have been previously allocated on the system using MfpgaCommandAlloc().

ControlFlag

Reserved for future expansion. Set this parameter to M_DEFAULT.

Return value
The returned value is M_VALID if deallocation is successful. If deallocation fails, M_NULL is returned.
Compilation information
Header Include mil.h; milfpga.h.
Library Use mil.lib; milfpga.lib.
DLL Requires mil.dll; milfpga.dll.