CDI_Return_HACB

Returns memory allocated for a SuperHACB back to the system memory pool.

Thread Context:Non-Blocking

Syntax

    LONG CDI_Return_HACB (
       LONG    cdmOSHandle,
       LONG   hacbPutHandle
       );

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.
hacbPutHandle
(IN) Handle to the HACB being deallocated. The value of this parameter is obtained from the hacbPutHandle field of the original SuperHACB's member HACB.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

CDI_Return_HACB is used by a CDM to return the memory allocated for a SuperHACB to the system memory pool. Typically, CDI_Return_HACB is called when a SuperHACB structure becomes corrupted and cannot be reused for building subsequent requests, or when the CDM is ready to unload.