| Current File : //usr/share/doc/dbus/api/dbus-signature_8h_source.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"/>
<title>D-Bus: dbus-signature.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">D-Bus
 <span id="projectnumber">1.8.20</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">dbus-signature.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/* dbus-signatures.h utility functions for D-Bus types</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2005 Red Hat Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00011"></a>00011 <span class="comment"> * (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 <span class="preprocessor">#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef DBUS_SIGNATURES_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_SIGNATURES_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <dbus/dbus-macros.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <dbus/dbus-types.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <dbus/dbus-errors.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <a class="code" href="group__DBusMacros.html#ga875146b01015e9ced22b25d76d549ab2" title="Macro used prior to declaring functions in the D-Bus header files.">DBUS_BEGIN_DECLS</a>
<a name="l00035"></a>00035
<a name="l00044"></a><a class="code" href="structDBusSignatureIter.html">00044</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00045"></a>00045 {
<a name="l00046"></a><a class="code" href="structDBusSignatureIter.html#a9245daf488cdab318d05571a165347e2">00046</a> <span class="keywordtype">void</span> *<a class="code" href="structDBusSignatureIter.html#a9245daf488cdab318d05571a165347e2" title="Don't use this.">dummy1</a>;
<a name="l00047"></a><a class="code" href="structDBusSignatureIter.html#a4dbc68c49a71311668c4402541f714e4">00047</a> <span class="keywordtype">void</span> *<a class="code" href="structDBusSignatureIter.html#a4dbc68c49a71311668c4402541f714e4" title="Don't use this.">dummy2</a>;
<a name="l00048"></a><a class="code" href="structDBusSignatureIter.html#ab10196c1037786fb1b6c942f83ef56e1">00048</a> <a class="code" href="group__DBusTypes.html#gaf513803b030613a669cc7ef199f90a8b" title="A 32-bit unsigned integer on all platforms.">dbus_uint32_t</a> <a class="code" href="structDBusSignatureIter.html#ab10196c1037786fb1b6c942f83ef56e1" title="Don't use this.">dummy8</a>;
<a name="l00049"></a><a class="code" href="structDBusSignatureIter.html#a44427aa17d2ab663f9b8e563617bb7d0">00049</a> <span class="keywordtype">int</span> <a class="code" href="structDBusSignatureIter.html#a44427aa17d2ab663f9b8e563617bb7d0" title="Don't use this.">dummy12</a>;
<a name="l00050"></a><a class="code" href="structDBusSignatureIter.html#aefd7d91e7b15ec7ab8ccf99b744d031d">00050</a> <span class="keywordtype">int</span> <a class="code" href="structDBusSignatureIter.html#aefd7d91e7b15ec7ab8ccf99b744d031d" title="Don't use this.">dummy17</a>;
<a name="l00051"></a>00051 } <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a>;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 DBUS_EXPORT
<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="group__DBusSignature.html#gaba53b1756fe7f665d0657cc50253e3c8" title="Initializes a DBusSignatureIter for reading a type signature.">dbus_signature_iter_init</a> (<a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter,
<a name="l00055"></a>00055 <span class="keyword">const</span> <span class="keywordtype">char</span> *signature);
<a name="l00056"></a>00056
<a name="l00057"></a>00057 DBUS_EXPORT
<a name="l00058"></a>00058 <span class="keywordtype">int</span> <a class="code" href="group__DBusSignature.html#gac4761ce10d60d7581cfe98beb6a9c57c" title="Returns the current type pointed to by the iterator.">dbus_signature_iter_get_current_type</a> (<span class="keyword">const</span> <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 DBUS_EXPORT
<a name="l00061"></a>00061 <span class="keywordtype">char</span> * <a class="code" href="group__DBusSignature.html#ga898bbc14392cbedc087ce0be68d35c98" title="Returns the signature of the single complete type starting at the given iterator.">dbus_signature_iter_get_signature</a> (<span class="keyword">const</span> <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 DBUS_EXPORT
<a name="l00064"></a>00064 <span class="keywordtype">int</span> <a class="code" href="group__DBusSignature.html#gaebb26dbc79dae5e11629f38b2c8277fd" title="Convenience function for returning the element type of an array; This function allows you to avoid in...">dbus_signature_iter_get_element_type</a> (<span class="keyword">const</span> <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 DBUS_EXPORT
<a name="l00067"></a>00067 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#ga90e48ef4b86180ba033727107b03bd29" title="Skip to the next value on this "level".">dbus_signature_iter_next</a> (<a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter);
<a name="l00068"></a>00068
<a name="l00069"></a>00069 DBUS_EXPORT
<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="group__DBusSignature.html#ga0bd324faaf2dad5d075de3ff6c9b6796" title="Initialize a new iterator pointing to the first type in the current container.">dbus_signature_iter_recurse</a> (<span class="keyword">const</span> <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *iter,
<a name="l00071"></a>00071 <a class="code" href="structDBusSignatureIter.html" title="DBusSignatureIter struct; contains no public fields.">DBusSignatureIter</a> *subiter);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 DBUS_EXPORT
<a name="l00074"></a>00074 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#ga0f4b81be4f6193c7d8da0ee214772e02" title="Check a type signature for validity.">dbus_signature_validate</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *signature,
<a name="l00075"></a>00075 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00076"></a>00076
<a name="l00077"></a>00077 DBUS_EXPORT
<a name="l00078"></a>00078 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#gac375412dd15a7412967a927d17b6f3d8" title="Check that a type signature is both valid and contains exactly one complete type.">dbus_signature_validate_single</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *signature,
<a name="l00079"></a>00079 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 DBUS_EXPORT
<a name="l00082"></a>00082 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#ga7093ae3b35eb073dab939dae69b8c689" title="Return TRUE if the argument is a valid typecode.">dbus_type_is_valid</a> (<span class="keywordtype">int</span> typecode);
<a name="l00083"></a>00083
<a name="l00084"></a>00084 DBUS_EXPORT
<a name="l00085"></a>00085 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#ga2d8afef7d754cf15d6b9733f00654c0e" title="A "basic type" is a somewhat arbitrary concept, but the intent is to include those types that are ful...">dbus_type_is_basic</a> (<span class="keywordtype">int</span> typecode);
<a name="l00086"></a>00086 DBUS_EXPORT
<a name="l00087"></a>00087 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#gaa0c4c8aa34fa266daa55bd37bdad39b8" title="A "container type" can contain basic types, or nested container types.">dbus_type_is_container</a> (<span class="keywordtype">int</span> typecode);
<a name="l00088"></a>00088 DBUS_EXPORT
<a name="l00089"></a>00089 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusSignature.html#ga2f89962cbd33e4ad843824157bae2093" title="Tells you whether values of this type can change length if you set them to some other value...">dbus_type_is_fixed</a> (<span class="keywordtype">int</span> typecode);
<a name="l00090"></a>00090
<a name="l00093"></a>00093 <a class="code" href="group__DBusMacros.html#gae4a9263a43f8220f6e1c0fd07cf6e59a" title="Macro used after declaring functions in the D-Bus header files.">DBUS_END_DECLS</a>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_SIGNATURE_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:31 for D-Bus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>