oracular (3) cmap_initialize.3.gz

Provided by: libcmap-dev_3.1.8-2ubuntu1_amd64 bug

NAME

       cmap_initialize - Initialize CMAP API

SYNOPSIS

       #include <corosync/cmap.h>

       cs_error_t cmap_initialize (cmap_handle_t *handle);

DESCRIPTION

       The  cmap_initialize  function  is  used  to  initialize  a connection to the Configuration Map API. Each
       application may have several connections to the CMAP API.  Each application uses the handle  argument  to
       uniquely  identify  the connection.  The handle argument is then used in other function calls to identify
       the connection to be used for communication with the CMAP service.

RETURN VALUE

       This call returns the CS_OK value if successful, otherwise an error is returned.

SEE ALSO

       cmap_finalize(3), cmap_initialize_map(3), cmap_overview(3)

       CS_ERR_TRY_AGAIN Resource temporarily unavailable

       CS_ERR_INVALID_PARAM Invalid argument

       CS_ERR_ACCESS Permission denied

       CS_ERR_LIBRARY The connection failed

       CS_ERR_INTERRUPT System call interrupted by a signal

       CS_ERR_NOT_SUPPORTED The requested protocol/functionality not supported

       CS_ERR_MESSAGE_ERROR Incorrect auth message received

       CS_ERR_NO_MEMORY Not enough memory to complete the requested task