UCM Unitec Home Page
      

Close an UCM Connection

 UcmClose(F)

Synopsis   Environment   Description   Diagnostics   See also   Examples

Synopsis

#include "ucm.h"

int UcmClose(sock);
T_SOCKET sock;

Environment

Unix, Win32

Description

The UcmClose function closes the socket sock, that has been initialized by UcmConnect or UcmOpen. In order to allow correct socket housekeeping, this call is mandatory.

UcmClose will fail if one or more of the following is true:

UE_NOTINIT The UCM software has not been initialize (see UcmInit)
UE_BADSOCK The value of sock is not a valid socket descriptor or the socket is not open.

Diagnostics

Upon successful completion UcmClose returns UCM_SUCCESS. Otherwise, UCM_ERROR is returned and ucmErrno is set to indicate the error.

See also

UcmConnect, UcmInit, UcmOpen

Examples

See UcmOpen.

 

Back to top