CDI_Return_CDMMessage

Returns a CDM message to the system message pool.

Thread Context:Non-Blocking

Syntax

    LONG CDI_Return_CDMMessage (
       LONG   cdmOSHandle,
       LONG   cdmPutHandle
       );

Parameters

cdmOSHandle
(IN) The CDM's handle for using the CDI APIs. The value of cdmOSHandle was assigned during CDI_Register_CDM, and it is used in conjunction with the CDM-generated cdmHandle to uniquely identify a CDM when it interfaces with NWPA through the CDI API set.
cdmPutHandle
(IN) Handle to the CDM being deallocated. The value of this parameter is obtained from the cdmPutHandle field of the original CDM message being returned.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

CDI_Return_CDMMessage is used by a CDM to return the message allocated for a CDM message to the system message pool. Typically, CDI_Return_CDMMessage is called when a CDM message structure is no longer needed or when the CDM is ready to unload.