mirror of https://github.com/ecmwf/eccodes.git
1123 lines
55 KiB
HTML
1123 lines
55 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>eccodes: Accessing header and data values</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">eccodes
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>C Interface</span></a></li>
|
|
<li><a href="classeccodes.html"><span>F90 Interface</span></a></li>
|
|
<li><a href="namespaces.html"><span>Python Interface</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Accessing header and data values</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gaefda2b7765e1b737bcd05a825d231a1d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gaefda2b7765e1b737bcd05a825d231a1d">codes_get_offset</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, size_t *offset)</td></tr>
|
|
<tr class="memdesc:gaefda2b7765e1b737bcd05a825d231a1d"><td class="mdescLeft"> </td><td class="mdescRight">Get the number offset of a key, in a message if several keys of the same name are present, the offset of the last one is returned. <a href="#gaefda2b7765e1b737bcd05a825d231a1d">More...</a><br/></td></tr>
|
|
<tr class="separator:gaefda2b7765e1b737bcd05a825d231a1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga614d4f7a6c789a4fe60ea976b6644343"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga614d4f7a6c789a4fe60ea976b6644343">codes_get_size</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, size_t *size)</td></tr>
|
|
<tr class="memdesc:ga614d4f7a6c789a4fe60ea976b6644343"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of coded value from a key, if several keys of the same name are present, the total sum is returned. <a href="#ga614d4f7a6c789a4fe60ea976b6644343">More...</a><br/></td></tr>
|
|
<tr class="separator:ga614d4f7a6c789a4fe60ea976b6644343"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga98d694dc6caa24afdd393440c94c38f8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga98d694dc6caa24afdd393440c94c38f8">codes_get_length</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga98d694dc6caa24afdd393440c94c38f8"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of the string representation of the key, if several keys of the same name are present, the maximum length is returned. <a href="#ga98d694dc6caa24afdd393440c94c38f8">More...</a><br/></td></tr>
|
|
<tr class="separator:ga98d694dc6caa24afdd393440c94c38f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6ff44dddc3bec09f710b0aa8d0dbded7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga6ff44dddc3bec09f710b0aa8d0dbded7">codes_get_long</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, long *value)</td></tr>
|
|
<tr class="memdesc:ga6ff44dddc3bec09f710b0aa8d0dbded7"><td class="mdescLeft"> </td><td class="mdescRight">Get a long value from a key, if several keys of the same name are present, the last one is returned. <a href="#ga6ff44dddc3bec09f710b0aa8d0dbded7">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6ff44dddc3bec09f710b0aa8d0dbded7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga93c1b612b2b70bbbff335b7d227316fc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga93c1b612b2b70bbbff335b7d227316fc">codes_get_double</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, double *value)</td></tr>
|
|
<tr class="memdesc:ga93c1b612b2b70bbbff335b7d227316fc"><td class="mdescLeft"> </td><td class="mdescRight">Get a double value from a key, if several keys of the same name are present, the last one is returned. <a href="#ga93c1b612b2b70bbbff335b7d227316fc">More...</a><br/></td></tr>
|
|
<tr class="separator:ga93c1b612b2b70bbbff335b7d227316fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga15b9a4d8dae3002f0b4f6ef4f1cfc197"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga15b9a4d8dae3002f0b4f6ef4f1cfc197">codes_get_double_element</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, int i, double *value)</td></tr>
|
|
<tr class="memdesc:ga15b9a4d8dae3002f0b4f6ef4f1cfc197"><td class="mdescLeft"> </td><td class="mdescRight">Get as double the i-th element of the "key" array. <a href="#ga15b9a4d8dae3002f0b4f6ef4f1cfc197">More...</a><br/></td></tr>
|
|
<tr class="separator:ga15b9a4d8dae3002f0b4f6ef4f1cfc197"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga853aad2cd2bea6b71b8c61fed6adfe0b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga853aad2cd2bea6b71b8c61fed6adfe0b">codes_get_double_elements</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, int *i, long size, double *value)</td></tr>
|
|
<tr class="memdesc:ga853aad2cd2bea6b71b8c61fed6adfe0b"><td class="mdescLeft"> </td><td class="mdescRight">Get as double array the elements of the "key" array whose indexes are listed in the input array i. <a href="#ga853aad2cd2bea6b71b8c61fed6adfe0b">More...</a><br/></td></tr>
|
|
<tr class="separator:ga853aad2cd2bea6b71b8c61fed6adfe0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga638d7bbe8dafd11847222a99b259f408"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga638d7bbe8dafd11847222a99b259f408">codes_get_string</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, char *mesg, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga638d7bbe8dafd11847222a99b259f408"><td class="mdescLeft"> </td><td class="mdescRight">Get a string value from a key, if several keys of the same name are present, the last one is returned. <a href="#ga638d7bbe8dafd11847222a99b259f408">More...</a><br/></td></tr>
|
|
<tr class="separator:ga638d7bbe8dafd11847222a99b259f408"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga252c3104621144fb370f302f3a3f6755"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga252c3104621144fb370f302f3a3f6755">codes_get_bytes</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, unsigned char *bytes, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga252c3104621144fb370f302f3a3f6755"><td class="mdescLeft"> </td><td class="mdescRight">Get raw bytes values from a key. <a href="#ga252c3104621144fb370f302f3a3f6755">More...</a><br/></td></tr>
|
|
<tr class="separator:ga252c3104621144fb370f302f3a3f6755"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga82b919c3196525ec2f21a8378d4cbbf4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga82b919c3196525ec2f21a8378d4cbbf4">codes_get_double_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, double *vals, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga82b919c3196525ec2f21a8378d4cbbf4"><td class="mdescLeft"> </td><td class="mdescRight">Get double array values from a key. <a href="#ga82b919c3196525ec2f21a8378d4cbbf4">More...</a><br/></td></tr>
|
|
<tr class="separator:ga82b919c3196525ec2f21a8378d4cbbf4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac43a3c0bf2561ceeb4bcc22d734b53b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gac43a3c0bf2561ceeb4bcc22d734b53b1">codes_get_long_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, long *vals, size_t *length)</td></tr>
|
|
<tr class="memdesc:gac43a3c0bf2561ceeb4bcc22d734b53b1"><td class="mdescLeft"> </td><td class="mdescRight">Get long array values from a key. <a href="#gac43a3c0bf2561ceeb4bcc22d734b53b1">More...</a><br/></td></tr>
|
|
<tr class="separator:gac43a3c0bf2561ceeb4bcc22d734b53b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaecd9fa4b22117df7569320ddaa2431e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gaecd9fa4b22117df7569320ddaa2431e1">codes_copy_namespace</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *dest, const char *name, <a class="el" href="structcodes__handle.html">codes_handle</a> *src)</td></tr>
|
|
<tr class="memdesc:gaecd9fa4b22117df7569320ddaa2431e1"><td class="mdescLeft"> </td><td class="mdescRight">Copy the keys belonging to a given namespace from a source handle to a destination handle. <a href="#gaecd9fa4b22117df7569320ddaa2431e1">More...</a><br/></td></tr>
|
|
<tr class="separator:gaecd9fa4b22117df7569320ddaa2431e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga385881244ca6ef4be9ecee93025c862f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga385881244ca6ef4be9ecee93025c862f">codes_set_long</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, long val)</td></tr>
|
|
<tr class="memdesc:ga385881244ca6ef4be9ecee93025c862f"><td class="mdescLeft"> </td><td class="mdescRight">Set a long value from a key. <a href="#ga385881244ca6ef4be9ecee93025c862f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga385881244ca6ef4be9ecee93025c862f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7d2d68482b903b40b91a0b334855db5f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga7d2d68482b903b40b91a0b334855db5f">codes_set_double</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, double val)</td></tr>
|
|
<tr class="memdesc:ga7d2d68482b903b40b91a0b334855db5f"><td class="mdescLeft"> </td><td class="mdescRight">Set a double value from a key. <a href="#ga7d2d68482b903b40b91a0b334855db5f">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7d2d68482b903b40b91a0b334855db5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6062cdd5950966bffa72e74708f85368"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga6062cdd5950966bffa72e74708f85368">codes_set_string</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const char *mesg, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga6062cdd5950966bffa72e74708f85368"><td class="mdescLeft"> </td><td class="mdescRight">Set a string value from a key. <a href="#ga6062cdd5950966bffa72e74708f85368">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6062cdd5950966bffa72e74708f85368"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7acb877bea87a39b3778c21dd8de46c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga7acb877bea87a39b3778c21dd8de46c2">codes_set_bytes</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const unsigned char *bytes, size_t *length)</td></tr>
|
|
<tr class="memdesc:ga7acb877bea87a39b3778c21dd8de46c2"><td class="mdescLeft"> </td><td class="mdescRight">Set a bytes array from a key. <a href="#ga7acb877bea87a39b3778c21dd8de46c2">More...</a><br/></td></tr>
|
|
<tr class="separator:ga7acb877bea87a39b3778c21dd8de46c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaff9b5bde2baf126d93f43100e5c1d3f7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gaff9b5bde2baf126d93f43100e5c1d3f7">codes_set_double_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const double *vals, size_t length)</td></tr>
|
|
<tr class="memdesc:gaff9b5bde2baf126d93f43100e5c1d3f7"><td class="mdescLeft"> </td><td class="mdescRight">Set a double array from a key. <a href="#gaff9b5bde2baf126d93f43100e5c1d3f7">More...</a><br/></td></tr>
|
|
<tr class="separator:gaff9b5bde2baf126d93f43100e5c1d3f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5610a608f1e58996fa48c7ac8f3859a3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga5610a608f1e58996fa48c7ac8f3859a3">codes_set_force_double_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const double *vals, size_t length)</td></tr>
|
|
<tr class="memdesc:ga5610a608f1e58996fa48c7ac8f3859a3"><td class="mdescLeft"> </td><td class="mdescRight">Same as codes_set_double_array but allows setting of READ-ONLY keys like codedValues. <a href="#ga5610a608f1e58996fa48c7ac8f3859a3">More...</a><br/></td></tr>
|
|
<tr class="separator:ga5610a608f1e58996fa48c7ac8f3859a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabb904f520644caa008034bd2be9349ec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#gabb904f520644caa008034bd2be9349ec">codes_set_long_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const long *vals, size_t length)</td></tr>
|
|
<tr class="memdesc:gabb904f520644caa008034bd2be9349ec"><td class="mdescLeft"> </td><td class="mdescRight">Set a long array from a key. <a href="#gabb904f520644caa008034bd2be9349ec">More...</a><br/></td></tr>
|
|
<tr class="separator:gabb904f520644caa008034bd2be9349ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6840ee00df4366a431bedcef609f8ae5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5">codes_set_string_array</a> (<a class="el" href="structcodes__handle.html">codes_handle</a> *h, const char *key, const char **vals, size_t length)</td></tr>
|
|
<tr class="memdesc:ga6840ee00df4366a431bedcef609f8ae5"><td class="mdescLeft"> </td><td class="mdescRight">Set a string array from a key. <a href="#ga6840ee00df4366a431bedcef609f8ae5">More...</a><br/></td></tr>
|
|
<tr class="separator:ga6840ee00df4366a431bedcef609f8ae5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gaecd9fa4b22117df7569320ddaa2431e1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_copy_namespace </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>dest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>src</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy the keys belonging to a given namespace from a source handle to a destination handle. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>: destination handle </td></tr>
|
|
<tr><td class="paramname">name</td><td>: namespace </td></tr>
|
|
<tr><td class="paramname">src</td><td>: source handle </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga252c3104621144fb370f302f3a3f6755"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_bytes </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned char * </td>
|
|
<td class="paramname"><em>bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get raw bytes values from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is returned </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga7acb877bea87a39b3778c21dd8de46c2" title="Set a bytes array from a key. ">codes_set_bytes</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">bytes</td><td>: the address of a byte array where the data will be retrieved </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains allocated length of the byte array on input, and that contains the actual length of the byte array on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga93c1b612b2b70bbbff335b7d227316fc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_double </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a double value from a key, if several keys of the same name are present, the last one is returned. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga7d2d68482b903b40b91a0b334855db5f" title="Set a double value from a key. ">codes_set_double</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">value</td><td>: the address of a double where the data will be retrieved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga82b919c3196525ec2f21a8378d4cbbf4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_double_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get double array values from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is returned </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#gaff9b5bde2baf126d93f43100e5c1d3f7" title="Set a double array from a key. ">codes_set_double_array</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">vals</td><td>: the address of a double array where the data will be retrieved </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains allocated length of the double array on input, and that contains the actual length of the double array on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga15b9a4d8dae3002f0b4f6ef4f1cfc197"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_double_element </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get as double the i-th element of the "key" array. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">i</td><td>: zero-based index </td></tr>
|
|
<tr><td class="paramname">value</td><td>: the address of a double where the data will be retrieved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga853aad2cd2bea6b71b8c61fed6adfe0b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_double_elements </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get as double array the elements of the "key" array whose indexes are listed in the input array i. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">i</td><td>: zero-based array of indexes </td></tr>
|
|
<tr><td class="paramname">size</td><td>: size of the i and value arrays </td></tr>
|
|
<tr><td class="paramname">value</td><td>: the double array for the data values </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga98d694dc6caa24afdd393440c94c38f8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_length </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the length of the string representation of the key, if several keys of the same name are present, the maximum length is returned. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the offset from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t where the length will be set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6ff44dddc3bec09f710b0aa8d0dbded7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_long </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long * </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a long value from a key, if several keys of the same name are present, the last one is returned. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga385881244ca6ef4be9ecee93025c862f" title="Set a long value from a key. ">codes_set_long</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">value</td><td>: the address of a long where the data will be retrieved </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gac43a3c0bf2561ceeb4bcc22d734b53b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_long_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long * </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get long array values from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is returned </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#gabb904f520644caa008034bd2be9349ec" title="Set a long array from a key. ">codes_set_long_array</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">vals</td><td>: the address of a long array where the data will be retrieved </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains allocated length of the long array on input, and that contains the actual length of the long array on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaefda2b7765e1b737bcd05a825d231a1d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_offset </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>offset</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number offset of a key, in a message if several keys of the same name are present, the offset of the last one is returned. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the offset from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">offset</td><td>: the address of a size_t where the offset will be set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga614d4f7a6c789a4fe60ea976b6644343"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_size </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of coded value from a key, if several keys of the same name are present, the total sum is returned. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the offset from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">size</td><td>: the address of a size_t where the size will be set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga638d7bbe8dafd11847222a99b259f408"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_get_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>mesg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a string value from a key, if several keys of the same name are present, the last one is returned. </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga6062cdd5950966bffa72e74708f85368" title="Set a string value from a key. ">codes_set_string</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to get the data from </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">mesg</td><td>: the address of a string where the data will be retrieved </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains allocated length of the string on input, and that contains the actual length of the string on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7acb877bea87a39b3778c21dd8de46c2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_bytes </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const unsigned char * </td>
|
|
<td class="paramname"><em>bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a bytes array from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga252c3104621144fb370f302f3a3f6755" title="Get raw bytes values from a key. ">codes_get_bytes</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">bytes</td><td>: the address of a byte array where the data will be read </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains the length of the byte array on input, and that contains the actual packed length of the byte array on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7d2d68482b903b40b91a0b334855db5f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_double </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">double </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a double value from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga93c1b612b2b70bbbff335b7d227316fc" title="Get a double value from a key, if several keys of the same name are present, the last one is returned...">codes_get_double</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">val</td><td>: a double where the data will be read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gaff9b5bde2baf126d93f43100e5c1d3f7"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_double_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const double * </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a double array from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga82b919c3196525ec2f21a8378d4cbbf4" title="Get double array values from a key. ">codes_get_double_array</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">vals</td><td>: the address of a double array where the data will be read </td></tr>
|
|
<tr><td class="paramname">length</td><td>: a size_t that contains the length of the byte array on input </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga5610a608f1e58996fa48c7ac8f3859a3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_force_double_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const double * </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Same as codes_set_double_array but allows setting of READ-ONLY keys like codedValues. </p>
|
|
<p>Use with great caution!! </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga385881244ca6ef4be9ecee93025c862f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_long </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>val</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a long value from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga6ff44dddc3bec09f710b0aa8d0dbded7" title="Get a long value from a key, if several keys of the same name are present, the last one is returned...">codes_get_long</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">val</td><td>: a long where the data will be read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="gabb904f520644caa008034bd2be9349ec"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_long_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const long * </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a long array from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#gac43a3c0bf2561ceeb4bcc22d734b53b1" title="Get long array values from a key. ">codes_get_long_array</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">vals</td><td>: the address of a long array where the data will be read </td></tr>
|
|
<tr><td class="paramname">length</td><td>: a size_t that contains the length of the long array on input </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6062cdd5950966bffa72e74708f85368"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_string </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>mesg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t * </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a string value from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#ga638d7bbe8dafd11847222a99b259f408" title="Get a string value from a key, if several keys of the same name are present, the last one is returned...">codes_get_string</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">mesg</td><td>: the address of a string where the data will be read </td></tr>
|
|
<tr><td class="paramname">length</td><td>: the address of a size_t that contains the length of the string on input, and that contains the actual packed length of the string on output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga6840ee00df4366a431bedcef609f8ae5"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int codes_set_string_array </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structcodes__handle.html">codes_handle</a> * </td>
|
|
<td class="paramname"><em>h</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char ** </td>
|
|
<td class="paramname"><em>vals</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>length</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a string array from a key. </p>
|
|
<p>If several keys of the same name are present, the last one is set </p>
|
|
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__get__set.html#gac43a3c0bf2561ceeb4bcc22d734b53b1" title="Get long array values from a key. ">codes_get_long_array</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">h</td><td>: the handle to set the data to </td></tr>
|
|
<tr><td class="paramname">key</td><td>: the key to be searched </td></tr>
|
|
<tr><td class="paramname">vals</td><td>: the address of a string array where the data will be read </td></tr>
|
|
<tr><td class="paramname">length</td><td>: a size_t that contains the length of the array on input </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if OK, integer value on error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.5
|
|
</small></address>
|
|
</body>
|
|
</html>
|