Sophie

Sophie

distrib > Mandriva > 2007.0 > x86_64 > media > main-release > by-pkgid > 926d2d1e3111287cee1b0a4fad4fb4f6 > files > 160

lib64dbus-1_3-devel-0.92-6mdv2007.0.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Address parsing</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>Address parsing<br>
<small>
[<a class="el" href="group__DBus.html">D-BUS message system public API</a>]</small>
</h1>Parsing addresses of D-BUS servers. 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__DBusAddress.html#a0">dbus_address_entries_free</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> **entries)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Frees a <a class="el" href="group__DBusMacros.html#a4">NULL</a>-terminated array of address entries.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__DBusAddress.html#a2">dbus_address_entry_get_method</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *entry)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns the method string of an address entry.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const char *&nbsp;</td><td valign=bottom><a class="el" href="group__DBusAddress.html#a3">dbus_address_entry_get_value</a> (<a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *entry, const char *key)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns a value from a key of an entry.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a>&nbsp;</td><td valign=bottom><a class="el" href="group__DBusAddress.html#a4">dbus_parse_address</a> (const char *address, <a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> ***entry, int *array_len, <a class="el" href="structDBusError.html">DBusError</a> *error)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Parses an address string of the form:.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Parsing addresses of D-BUS servers.
<p>

<p>
 <hr><h2>Function Documentation</h2>
<a name="a0" doxytag="dbus-address.c::dbus_address_entries_free"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void dbus_address_entries_free </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> **&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>entries</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Frees a <a class="el" href="group__DBusMacros.html#a4">NULL</a>-terminated array of address entries.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>entries</em>&nbsp;</td><td>
the array. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00095">95</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="dbus-address.c::dbus_address_entry_get_method"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const char* dbus_address_entry_get_method </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>entry</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the method string of an address entry.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>entry</em>&nbsp;</td><td>
the entry. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
a string describing the method. This string must not be freed. </dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00131">131</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
References <a class="el" href="dbus-address_8c-source.html#l00043">DBusAddressEntry::method</a>.    </td>
  </tr>
</table>
<a name="a3" doxytag="dbus-address.c::dbus_address_entry_get_value"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> const char* dbus_address_entry_get_value </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>entry</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>key</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns a value from a key of an entry.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>entry</em>&nbsp;</td><td>
the entry. </td></tr>
<tr><td valign=top><em>key</em>&nbsp;</td><td>
the key. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
the key value. This string must not be fred. </dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00144">144</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
References <a class="el" href="dbus-list_8h-source.html#l00039">DBusList::data</a>, <a class="el" href="dbus-address_8c-source.html#l00045">DBusAddressEntry::keys</a>, and <a class="el" href="dbus-address_8c-source.html#l00046">DBusAddressEntry::values</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="dbus-address.c::dbus_parse_address"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="group__DBusTypes.html#a2">dbus_bool_t</a> dbus_parse_address </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>address</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structDBusAddressEntry.html">DBusAddressEntry</a> ***&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>entry</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>array_len</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="structDBusError.html">DBusError</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>error</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Parses an address string of the form:.
<p>
method:key=value,key=value;method:key=value
<p>

<p>
<dl compact><dt><b>
<a class="el" href="todo.html#_todo000001">Todo: </a></b><dd>
document address format in the specification 
<p>
need to be able to escape ';' and ',' in the key values, and the parsing needs to handle that.</dl>
<p>

<p>
 <dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>address</em>&nbsp;</td><td>
the address. </td></tr>
<tr><td valign=top><em>entry</em>&nbsp;</td><td>
return location to an array of entries. </td></tr>
<tr><td valign=top><em>array_len</em>&nbsp;</td><td>
return location for array length. </td></tr>
<tr><td valign=top><em>error</em>&nbsp;</td><td>
address where an error can be returned. </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
<a class="el" href="group__DBusMacros.html#a2">TRUE</a> on success, <a class="el" href="group__DBusMacros.html#a3">FALSE</a> otherwise. </dl>
<p>
Definition at line <a class="el" href="dbus-address_8c-source.html#l00183">183</a> of file <a class="el" href="dbus-address_8c-source.html">dbus-address.c</a>.
<p>
References <a class="el" href="dbus-list_8h-source.html#l00039">DBusList::data</a>, <a class="el" href="dbus-address_8c-source.html#l00045">DBusAddressEntry::keys</a>, <a class="el" href="dbus-address_8c-source.html#l00043">DBusAddressEntry::method</a>, and <a class="el" href="dbus-address_8c-source.html#l00046">DBusAddressEntry::values</a>.    </td>
  </tr>
</table>
<hr><address align="right"><small>Generated on Wed Jun 9 05:01:27 2004 for D-BUS by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>