mirror of
https://github.com/deltachat/deltachat-core.git
synced 2025-10-04 18:29:19 +02:00
211 lines
10 KiB
HTML
211 lines
10 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: mrarray_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="structmrarray__t-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mrarray_t Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An object containing a simple array.
|
|
<a href="structmrarray__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="mrarray_8h_source.html">mrarray.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:a1400b5e42c682326e809723f02739a8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_unref</a> (<a class="el" href="structmrarray__t.html">mrarray_t</a> *array)</td></tr>
|
|
<tr class="memdesc:a1400b5e42c682326e809723f02739a8e"><td class="mdescLeft"> </td><td class="mdescRight">Free an array object. <a href="#a1400b5e42c682326e809723f02739a8e">More...</a><br /></td></tr>
|
|
<tr class="separator:a1400b5e42c682326e809723f02739a8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8">mrarray_get_cnt</a> (<a class="el" href="structmrarray__t.html">mrarray_t</a> *array)</td></tr>
|
|
<tr class="memdesc:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="mdescLeft"> </td><td class="mdescRight">Find out the number of items in an array. <a href="#a73f6d954ed1b97bbceb3cf7d8e1aeec8">More...</a><br /></td></tr>
|
|
<tr class="separator:a73f6d954ed1b97bbceb3cf7d8e1aeec8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40b1e875ba256b6ccbbe65f58bbc01ec"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec">mrarray_get_id</a> (<a class="el" href="structmrarray__t.html">mrarray_t</a> *array, size_t index)</td></tr>
|
|
<tr class="memdesc:a40b1e875ba256b6ccbbe65f58bbc01ec"><td class="mdescLeft"> </td><td class="mdescRight">Get the item at the given index as an ID. <a href="#a40b1e875ba256b6ccbbe65f58bbc01ec">More...</a><br /></td></tr>
|
|
<tr class="separator:a40b1e875ba256b6ccbbe65f58bbc01ec"><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 containing a simple array. </p>
|
|
<p>This object is used in several placed where functions need to return an array. The items of the array are typically IDs. To free an array object, use <a class="el" href="structmrarray__t.html#a1400b5e42c682326e809723f02739a8e" title="Free an array object. ">mrarray_unref()</a>. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a1400b5e42c682326e809723f02739a8e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mrarray_unref </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrarray__t.html">mrarray_t</a> * </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Free an array object. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td>The array object to free, created eg. by <a class="el" href="structmrmailbox__t.html#a4da10c87eb65bbf6c504979d75ec3b19" title="Get a list of chats. ">mrmailbox_get_chatlist()</a>, <a class="el" href="structmrmailbox__t.html#ae4ccc69ba8e8851a04f9b17b37e5f86a" title="Returns known and unblocked contacts. ">mrmailbox_get_known_contacts()</a> and so on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a73f6d954ed1b97bbceb3cf7d8e1aeec8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t mrarray_get_cnt </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrarray__t.html">mrarray_t</a> * </td>
|
|
<td class="paramname"><em>array</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find out the number of items in an array. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td>The array object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the number of items in a <a class="el" href="structmrarray__t.html" title="An object containing a simple array. ">mrarray_t</a> object. 0 on errors or if the array is empty. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a40b1e875ba256b6ccbbe65f58bbc01ec"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t mrarray_get_id </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structmrarray__t.html">mrarray_t</a> * </td>
|
|
<td class="paramname"><em>array</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>index</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the item at the given index as an ID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">array</td><td>The array object. </td></tr>
|
|
<tr><td class="paramname">index</td><td>Index of the item to get. Must be between 0 and <a class="el" href="structmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8" title="Find out the number of items in an array. ">mrarray_get_cnt()</a>-1.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the item at the given index. Returns 0 on errors or if the array is empty. </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="mrarray_8h_source.html">mrarray.h</a></li>
|
|
<li>/home/bpetersen/projects/deltachat-core/src/mrarray.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>
|