smc_connect_drop

Description

Deallocates a connection structure that was created with smc_connect_alloc.

Syntax

SMC_RETURN_CODE smc_connect_drop
 (SMC_CONNECT_ID clientId)

Parameters

clientId

identifies the connection.

Returns

Return value

Indicates

SMC_RET_SUCCESS

Function succeeded.

SMC_RET_FAILURE

Function failed.

SMC_RET_INVALID_CONNECT

Connection does not exist.

Examples

Example 1

This example assumes that:

Usage


Valid server modes

Mode

Availability

SMC_SERVER_M_LIVE

Yes

SMC_SERVER_M_HISTORICAL

Yes


Errors

Error

Indicates

SMC_RET_CONNECT_NOT_CLOSED

Connection has not been closed

SMC_RET_INVALID_API_FUNCTION

Invalid use of obsolete and replacement functions on the same connection

SMC_RET_INVALID_API_FUNC_SEQUENCE

Invalid calling sequence of Monitor Client Library functions

See also

smc_close, smc_connect_alloc