/usr/share/doc/corosync/html/cmap

<!-- Creator     : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:40 2014 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
       h1      { text-align: center }
</style>
<title>CMAP_GET</title>

</head>
<body>

<h1 align="center">CMAP_GET</h1>

<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#RETURN VALUE">RETURN VALUE</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>

<hr>


<h2>NAME
<a name="NAME"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">cmap_get
&minus; Retreive value from CMAP</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;corosync/cmap.h&gt;</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get (cmap_handle_t</b> <i>handle</i><b>, const char
*</b><i>key_name</i><b>, void *</b><i>value</i><b>, size_t
*</b><i>value_len</i><b>, cmap_value_types_t
*</b><i>type</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em">Also shortcuts
for different types are defined</p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_int8 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int8_t
*</b><i>i8</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_uint8 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint8_t
*</b><i>u8</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_int16 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int16_t
*</b><i>i16</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_uint16 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint16_t
*</b><i>u16</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_int32 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int32_t
*</b><i>i32</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_uint32 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint32_t
*</b><i>u32</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_int64 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int64_t
*</b><i>i64</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_uint64 (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint64_t
*</b><i>u64</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_float (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, float
*</b><i>flt</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_double (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, double
*</b><i>dbl</i><b>);</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_get_string (cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, char
**</b><i>str</i><b>);</b></p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The
<b>cmap_get</b> function is used to retreive key from cmap
previously set by <b>cmap_set(3)</b> function. The
<i>handle</i> argument is connection to CMAP database
obtained by calling <b>cmap_initialize(3)</b> function.
<i>key_name</i> is name of key to get value from.
<i>value</i> is pointer to preallocated data used as storage
for data, but can be also NULL, and then only
<i>value_len</i> and/or <i>type</i> is returned (both of
them can also be NULL, allowing function to be used only for
test of existence of key). If <i>value</i> is not NULL,
actual length of value in map is checked against
<i>*value_len.</i> If <i>*value_len</i> is shorter then
length of value in map, error CS_ERR_INVALID_PARAM is
returned. After successful copy of value, <i>*value_len</i>
is set to actual length of value in map. Parameter
<i>type</i> is pointer to memory, where type of value is
stored after successful return. Pointer can also be NULL and
then nothing is stored. Type can be one of:</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT8</b>
- 8-bit signed interger</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT8</b>
- 8-bit unsigned integer</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT16</b>
- 16-bit signed interger</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT16</b>
- 16-bit unsigned integer</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT32</b>
- 32-bit signed interger</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT32</b>
- 32-bit unsigned integer</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT64</b>
- 64-bit signed interger</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT64</b>
- 64-bit unsigned integer</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_FLOAT</b>
- Float value</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_DOUBLE</b>
- Double value</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_STRING</b>
- C-style string</p>


<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_BINARY</b>
- Binary data, byte with zero value has no special
meaning</p>

<p style="margin-left:11%; margin-top: 1em">Sortcut
functions tests cmap type with it&rsquo;s own type. If type
didn&rsquo;t match, CS_ERR_INVALID_PARAM error is returned.
No conversions are done, so for example
<b>cmap_get_int16</b> is not able to return value with
<b>CMAP_VALUETYPE_INT8</b> type.</p>

<p style="margin-left:11%; margin-top: 1em">String shortcut
function returns newly allocated memory and caller is
responsible for freeing that.</p>

<h2>RETURN VALUE
<a name="RETURN VALUE"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">This call
returns the CS_OK value if successful. If value or key_name
are unspecified, CS_ERR_INVALID_PARAM is returned. Same
error is also returned if <i>value</i> is specified, and
<i>*value_len</i> is too short for store of data. If key
doesn&rsquo;t exists (it was not set by calling
<b>cmap_set(3)</b> function first) CS_ERR_NOT_EXIST error is
returned. For helper functions, CS_ERR_INVALID_PARAM is
returned if type stored in cmap doesn&rsquo;t match with
type of helper function.</p>

<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>cmap_set</b>(3),
<b>cmap_initialize</b>(3), <b>cmap_overview</b>(8)</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_TRY_AGAIN</b>
Resource temporarily unavailable</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_INVALID_PARAM</b>
Invalid argument</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_ACCESS</b>
Permission denied</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_LIBRARY</b>
The connection failed</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_INTERRUPT</b>
System call inturrupted by a signal</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_NOT_SUPPORTED</b>
The requested protocol/functuality not supported</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_MESSAGE_ERROR</b>
Incorrect auth message received</p>


<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_NO_MEMORY</b>
Not enough memory to completed the requested task</p>
<hr>
</body>
</html>
libcmap-dev 2.3.3-1ubuntu1 / usr / share / doc / corosync / html / cmap_get.3.html
