mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
374 lines
17 KiB
HTML
374 lines
17 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.11"/>
|
|
<title>Delta Chat Core C-API: mrparam_t Struct Reference</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/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="user.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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Delta Chat Core C-API
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</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 id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="structmrparam__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrparam_t Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object for handling key=value parameter lists.
|
|
<a href="structmrparam__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mrparam_8h_source.html">mrparam.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a88397aa66e74bcdc61c8376c8e9a761b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a88397aa66e74bcdc61c8376c8e9a761b">mrparam_empty</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param)</td></tr>
|
|
<tr class="memdesc:a88397aa66e74bcdc61c8376c8e9a761b"><td class="mdescLeft"> </td><td class="mdescRight">Delete all parameters in the object. <a href="#a88397aa66e74bcdc61c8376c8e9a761b">More...</a><br /></td></tr>
|
|
<tr class="separator:a88397aa66e74bcdc61c8376c8e9a761b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a9d3768d128dce0088b089f66fafb68"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a0a9d3768d128dce0088b089f66fafb68">mrparam_exists</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key)</td></tr>
|
|
<tr class="memdesc:a0a9d3768d128dce0088b089f66fafb68"><td class="mdescLeft"> </td><td class="mdescRight">Check if a parameter exists. <a href="#a0a9d3768d128dce0088b089f66fafb68">More...</a><br /></td></tr>
|
|
<tr class="separator:a0a9d3768d128dce0088b089f66fafb68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23e24e8700e17ede6dd385fc90330f76"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a23e24e8700e17ede6dd385fc90330f76">mrparam_get</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key, const char *def)</td></tr>
|
|
<tr class="memdesc:a23e24e8700e17ede6dd385fc90330f76"><td class="mdescLeft"> </td><td class="mdescRight">Get value of a parameter. <a href="#a23e24e8700e17ede6dd385fc90330f76">More...</a><br /></td></tr>
|
|
<tr class="separator:a23e24e8700e17ede6dd385fc90330f76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba7d11db241c2ebbadab67895b84dae8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#aba7d11db241c2ebbadab67895b84dae8">mrparam_get_int</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key, int32_t def)</td></tr>
|
|
<tr class="memdesc:aba7d11db241c2ebbadab67895b84dae8"><td class="mdescLeft"> </td><td class="mdescRight">Get value of a parameter. <a href="#aba7d11db241c2ebbadab67895b84dae8">More...</a><br /></td></tr>
|
|
<tr class="separator:aba7d11db241c2ebbadab67895b84dae8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8399104724eab98103cdd2cd98b09d93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#a8399104724eab98103cdd2cd98b09d93">mrparam_set</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key, const char *value)</td></tr>
|
|
<tr class="memdesc:a8399104724eab98103cdd2cd98b09d93"><td class="mdescLeft"> </td><td class="mdescRight">Set parameter to a string. <a href="#a8399104724eab98103cdd2cd98b09d93">More...</a><br /></td></tr>
|
|
<tr class="separator:a8399104724eab98103cdd2cd98b09d93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf8fb80838add4d4254bb9fa2c11cb0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrparam__t.html#aaf8fb80838add4d4254bb9fa2c11cb0f">mrparam_set_int</a> (<a class="el" href="structmrparam__t.html">mrparam_t</a> *param, int key, int32_t value)</td></tr>
|
|
<tr class="memdesc:aaf8fb80838add4d4254bb9fa2c11cb0f"><td class="mdescLeft"> </td><td class="mdescRight">Set parameter to an integer. <a href="#aaf8fb80838add4d4254bb9fa2c11cb0f">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf8fb80838add4d4254bb9fa2c11cb0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An object for handling key=value parameter lists. </p>
|
|
<p>The parameter object is used eg. by <a class="el" href="structmrchat__t.html" title="An object representing a single chat in memory. ">mrchat_t</a> or <a class="el" href="structmrmsg__t.html" title="An object representing a single message in memory. ">mrmsg_t</a>. To access the single parameters use the setter and getter functions with an MRP_* constant, eg.</p>
|
|
<ul>
|
|
<li>MRP_FILE - the file associated with a message, not for text messages</li>
|
|
<li>MRP_WIDTH - the width of an image or video</li>
|
|
<li>MRP_HEIGHT - the height of an image or video</li>
|
|
<li>MRP_DURATION - the duration of an video or audio</li>
|
|
</ul>
|
|
<p>However, for most functions, it is easier to use more conctrete functions as <a class="el" href="structmrmsg__t.html#a2544769c77af5447546fcf5fc95c64f7" title="Find out full path, file name and extension of the file associated with a message. ">mrmsg_get_file()</a>. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a88397aa66e74bcdc61c8376c8e9a761b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrparam_empty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Delete all parameters in the object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to modify.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a9d3768d128dce0088b089f66fafb68"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int mrparam_exists </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>key</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if a parameter exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to query.</td></tr>
|
|
<tr><td class="paramname">key</td><td>Key of the parameter to check the existance, one of the MRP_* constants.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1=parameter exists in object, 0=parameter does not exist in parameter object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a23e24e8700e17ede6dd385fc90330f76"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char * mrparam_get </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </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>def</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get value of a parameter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to query.</td></tr>
|
|
<tr><td class="paramname">key</td><td>Key of the parameter to get, one of the MRP_* constants.</td></tr>
|
|
<tr><td class="paramname">def</td><td>Value to return if the parameter is not set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The stored value or the default value. In both cases, the returned value must be free()'d. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aba7d11db241c2ebbadab67895b84dae8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t mrparam_get_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>def</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get value of a parameter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to query.</td></tr>
|
|
<tr><td class="paramname">key</td><td>Key of the parameter to get, one of the MRP_* constants.</td></tr>
|
|
<tr><td class="paramname">def</td><td>Value to return if the parameter is not set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The stored value or the default value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8399104724eab98103cdd2cd98b09d93"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrparam_set </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </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>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set parameter to a string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to modify.</td></tr>
|
|
<tr><td class="paramname">key</td><td>Key of the parameter to modify, one of the MRP_* constants.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Value to store for key. NULL to clear the value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaf8fb80838add4d4254bb9fa2c11cb0f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrparam_set_int </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrparam__t.html">mrparam_t</a> * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </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>Set parameter to an integer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">param</td><td>Parameter object to modify.</td></tr>
|
|
<tr><td class="paramname">key</td><td>Key of the parameter to modify, one of the MRP_* constants.</td></tr>
|
|
<tr><td class="paramname">value</td><td>Value to store for key.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following files:<ul>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/<a class="el" href="mrparam_8h_source.html">mrparam.h</a></li>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/mrparam.c</li>
|
|
</ul>
|
|
</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.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|