CDI_Allocate_CDMMessage

Allocates CDM messages that are used to communicate with other CDMs.

Thread Context:Non-Blocking

Syntax

    LONG CDI_Allocate_CDMMessage(
       LONG                      cdmOSHandle,
       struct CDMMessageStruct **cdmMessage
       );

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 Handle to uniquely identify a CDM when it interfaces with NWPA through the CDI APIs.
cdmMessage
(IN/OUT) Point to the memory storage location of type CDMMessageStruct.

Return Values

The following table lists return values and descriptions.

zero

Successful

nonzero

Unsuccessful

Remarks

This function is used by a CDM to allocate a CDM message structure to be used by filter CDMs. Typically it is sent by CDI_Execute_CDMMessage.