---
name: "cmap_initialize_map"
section: "3"
platform: "linux"
package: "libcmap-dev"
version: "3.1.9-2+deb13u1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cmap_initialize_map"
---

# cmap\_initialize\_map(3)

Initialize CMAP API with a specific map

## NAME

cmap\_initialize\_map - Initialize CMAP API with a specific map

## SYNOPSIS

**#include \<corosync/cmap.h\>**

**cs\_error\_t cmap\_initialize\_map (cmap\_handle\_t** *\*handle***, cmap\_map\_t** *map***);**

## DESCRIPTION

The **cmap\_initialize\_map** function is used to initialize a connection to the Configuration Map API and specify a particular map to use. Each application may have several connections to the CMAP API and to different maps. 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.

The *map* argument specifies which map to connect to. *CMAP\_MAP\_ICMAP* **is the configuration map** **that contains the current corosyn cconfiguraton and some runtime variables that maybe useful** **to external agents.** *CMAP\_MAP\_STATS* **is the statistics map that contains detailed information** **about network and inter-process communications.**

## RETURN VALUE

**This call returns the CS\_OK value if successful, otherwise an error is returned.**

## SEE ALSO

[**cmap\_initialize**(3)](/cmap_initialize/3.md), [**cmap\_finalize**(3)](/cmap_finalize/3.md), [**cmap\_overview**(8)](/cmap_overview/8.md)

**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**