Sends a protocol-specific call message to a protocol.
DWORD nccSendCallMessage ( NCC_CALLHD callhd, void *message, unsigned *size )
|
Argument |
Description |
|
callhd |
Handle for the call about which a message should be sent. |
|
message |
Pointer to buffer containing the protocol-specific call message. |
|
size |
Size of the message buffer. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
message is NULL. |
|
CTAERR_INVALID_HANDLE |
The call handle is not valid. It may have been released. |
|
CTAERR_SVR_COMM |
A server communication error occurred. |
|
NCCERR_NOT_CAPABLE |
The protocol does not support the capability to send a call message. |
A protocol-specific event may be returned depending upon the protocol implementation.
nccSendCallMessage sends a protocol-specific call message to a protocol. The protocol defines the allowed protocol-specific call messages that it can receive. Use of this function requires that the application be aware of which protocol is being used.
You cannot send a call message that causes a state change as a result of successful message delivery.
Some protocols do not support the capability to send a call message. The application can determine if the protocol supports this capability by examining the NCC_CAP_SEND_CALL_MESSAGE bit in the capabilitymask returned by nccQueryCapability.
Refer to your protocol-specific documentation for more details on the use of this function.