UCM Unitec Home Page
      

Chapter 4 - Function Descriptions

 

4.1. Overview

This chapter contains descriptions of the application program interface of all UCM runtime library functions. The page headers for each description contain the function name and title.

The Synopsis section gives a summary of the actual function declaration.

The Description explains all of the function's operational details.

In the Diagnostics section, common status and error codes are listed, often with possible explanation for their occurrences.

Related functions are identified in the See Also section.

An Example section is provided for each function. The example is intended to illustrate how the function is called, not necessarily how to use the function. In some cases, the example is very brief. In all cases, it should be sufficient to show how the call is made.

The following functions are in alphabetical order:

Function Title
UcmClientVersion Get software version of UCM Client.
UcmClose Close an UCM Connection.
UcmCntl UCM control operations.
UcmConnect Connect to an UCM Server.
UcmInit Initialize UCM Communication.
UcmOpen Open UCM Server Connection.
UcmRecv Receive Message.
UcmSend Send Message.
UcmSendf Send Formatted Message.
UcmServer Generic UCM Server Function.
UcmTerm Terminate UCM Communication.
UcmVersion Get UCM library software version.


Return- and error codes of all UCM functions are described in ucmErrno.

 

Back to top