Sends a protocol-specific line message to a protocol.
DWORD nccSendLineMessage ( CTAHD linehd, void *message, unsigned size)
|
Argument |
Description |
|
linehd |
Line handle used to open the NCC API instance. |
|
message |
Pointer to a buffer containing the protocol-specific line message. |
|
size |
Size of the message buffer. |
|
Return value |
Description |
|
SUCCESS |
|
|
CTAERR_BAD_ARGUMENT |
message is NULL. |
|
CTAERR_INVALID_HANDLE |
The protocol is not running on the specified handle. |
|
CTAERR_SVR_COMM |
A server communication error occurred. |
|
NCCERR_NOT_CAPABLE |
The protocol does not support the capability to send a line message. |
A protocol-specific event may be returned depending upon the protocol implementation.
nccSendLineMessage sends a protocol-specific line message to a protocol. The protocol defines the allowed protocol-specific line messages that it can receive. The application must be aware of which protocol is being used.
You cannot send a line message that causes a state change as a result of successful message delivery.
Some protocols do not support the capability to send a line message. The application can determine if the protocol supports this capability by examining the NCC_CAP_SEND_LINE_MESSAGE bit in the capabilitymask returned by nccQueryCapability.
Refer to the protocol-specific documentation for more details on the use of this function.