nccStopProtocol

Uninitializes an NCC line.

Prototype

DWORD nccStopProtocol ( CTAHD linehd, void* stopparms )

Argument

Description

linehd

Line handle to uninitialize.

stopparms

Pointer to a protocol-specific NaturalAccess stop-protocol parameter structure. For a protocol-independent application using default parameters, pass NULL. See the protocol-specific documentation for details.

Return values

Return value

Description

SUCCESS

 

CTAERR_INVALID_HANDLE

The NCC API is not open on the specified line.

CTAERR_INVALID_STATE

No protocol is currently running on this line.

CTAERR_SVR_COMM

A server communication error occurred.

Events

Event

Description

NCCEVN_CALL_RELEASED

A call that was on the line was released before the protocol was stopped.

NCCEVN_STOP_PROTOCOL_DONE

The line state was successfully changed from idle to uninitialized. The line can no longer be used to accept and/or place calls.

Details

If nccStopProtocol succeeds, the line state becomes uninitialized. All calls on the line are automatically released before NCCEVN_STOP_PROTOCOL_DONE is returned.

See also

ctaOpenServices, nccStartProtocol