Technical Reference > CtAPI Functions > Function Reference > ctClose

ctClose

Closes the connection between the application and the CtAPI. When called, any pending commands will be canceled. You need to free any handles allocated before calling ctClose(). These handles are not freed when ctClose() is called. Call this function from an application on shutdown or when a major error occurs on the connection.

Syntax

ctClose(hCTAPI)

hCTAPI

Type: Handle
Input/output: Input
Description: The handle to the CTAPI as returned from ctOpen().

Return Value

TRUE if successful, otherwise FALSE. Use GetLastError() to get extended error information.

Related Functions

ctOpen

Example

See the example for ctOpen().