Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/enet-1.1/docs/html/group__Address.html @ 13

Last change on this file since 13 was 13, checked in by landauf, 16 years ago

added enet
File size: 8.6 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>enet: ENet address functions</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.1 -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
13    <li><a href="files.html"><span>Files</span></a></li>
14    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15  </ul></div>
16<h1>ENet address functions</h1>
17<p>
18<table border="0" cellpadding="0" cellspacing="0">
19<tr><td></td></tr>
20<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
21<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g32a6ae1ed3d7704858f237688e7384ee">enet_address_set_host</a> (<a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, const char *hostName)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful.  <a href="#g32a6ae1ed3d7704858f237688e7384ee"></a><br></td></tr>
24<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g770507a74d2e98334eebdadd9c681f69">enet_address_get_host_ip</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gives the printable form of the ip address specified in the address parameter.  <a href="#g770507a74d2e98334eebdadd9c681f69"></a><br></td></tr>
27<tr><td class="memItemLeft" nowrap align="right" valign="top">ENET_API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Address.html#g55282b3074cb409544f6aa72a67582ab">enet_address_get_host</a> (const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *address, char *hostName, size_t nameLength)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attempts to do a reverse lookup of the host field in the address parameter.  <a href="#g55282b3074cb409544f6aa72a67582ab"></a><br></td></tr>
30</table>
31<hr><h2>Function Documentation</h2>
32<a class="anchor" name="g55282b3074cb409544f6aa72a67582ab"></a><!-- doxytag: member="enet.h::enet_address_get_host" ref="g55282b3074cb409544f6aa72a67582ab" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
33<div class="memitem">
34<div class="memproto">
35      <table class="memname">
36        <tr>
37          <td class="memname">ENET_API int enet_address_get_host           </td>
38          <td>(</td>
39          <td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
40          <td class="paramname"> <em>address</em>, </td>
41        </tr>
42        <tr>
43          <td class="paramkey"></td>
44          <td></td>
45          <td class="paramtype">char *&nbsp;</td>
46          <td class="paramname"> <em>hostName</em>, </td>
47        </tr>
48        <tr>
49          <td class="paramkey"></td>
50          <td></td>
51          <td class="paramtype">size_t&nbsp;</td>
52          <td class="paramname"> <em>nameLength</em></td><td>&nbsp;</td>
53        </tr>
54        <tr>
55          <td></td>
56          <td>)</td>
57          <td></td><td></td><td width="100%"></td>
58        </tr>
59      </table>
60</div>
61<div class="memdoc">
62
63<p>
64<dl compact><dt><b>Parameters:</b></dt><dd>
65  <table border="0" cellspacing="2" cellpadding="0">
66    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>address used for reverse lookup </td></tr>
67    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>destination for name, must not be NULL </td></tr>
68    <tr><td valign="top"></td><td valign="top"><em>nameLength</em>&nbsp;</td><td>maximum length of hostName. </td></tr>
69  </table>
70</dl>
71<dl class="return" compact><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
72<dl compact><dt><b>Return values:</b></dt><dd>
73  <table border="0" cellspacing="2" cellpadding="0">
74    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
75    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
76  </table>
77</dl>
78
79</div>
80</div><p>
81<a class="anchor" name="g770507a74d2e98334eebdadd9c681f69"></a><!-- doxytag: member="enet.h::enet_address_get_host_ip" ref="g770507a74d2e98334eebdadd9c681f69" args="(const ENetAddress *address, char *hostName, size_t nameLength)" -->
82<div class="memitem">
83<div class="memproto">
84      <table class="memname">
85        <tr>
86          <td class="memname">ENET_API int enet_address_get_host_ip           </td>
87          <td>(</td>
88          <td class="paramtype">const <a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
89          <td class="paramname"> <em>address</em>, </td>
90        </tr>
91        <tr>
92          <td class="paramkey"></td>
93          <td></td>
94          <td class="paramtype">char *&nbsp;</td>
95          <td class="paramname"> <em>hostName</em>, </td>
96        </tr>
97        <tr>
98          <td class="paramkey"></td>
99          <td></td>
100          <td class="paramtype">size_t&nbsp;</td>
101          <td class="paramname"> <em>nameLength</em></td><td>&nbsp;</td>
102        </tr>
103        <tr>
104          <td></td>
105          <td>)</td>
106          <td></td><td></td><td width="100%"></td>
107        </tr>
108      </table>
109</div>
110<div class="memdoc">
111
112<p>
113<dl compact><dt><b>Parameters:</b></dt><dd>
114  <table border="0" cellspacing="2" cellpadding="0">
115    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>address printed </td></tr>
116    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>destination for name, must not be NULL </td></tr>
117    <tr><td valign="top"></td><td valign="top"><em>nameLength</em>&nbsp;</td><td>maximum length of hostName. </td></tr>
118  </table>
119</dl>
120<dl class="return" compact><dt><b>Returns:</b></dt><dd>the null-terminated name of the host in hostName on success </dd></dl>
121<dl compact><dt><b>Return values:</b></dt><dd>
122  <table border="0" cellspacing="2" cellpadding="0">
123    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
124    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
125  </table>
126</dl>
127
128</div>
129</div><p>
130<a class="anchor" name="g32a6ae1ed3d7704858f237688e7384ee"></a><!-- doxytag: member="enet.h::enet_address_set_host" ref="g32a6ae1ed3d7704858f237688e7384ee" args="(ENetAddress *address, const char *hostName)" -->
131<div class="memitem">
132<div class="memproto">
133      <table class="memname">
134        <tr>
135          <td class="memname">ENET_API int enet_address_set_host           </td>
136          <td>(</td>
137          <td class="paramtype"><a class="el" href="struct__ENetAddress.html">ENetAddress</a> *&nbsp;</td>
138          <td class="paramname"> <em>address</em>, </td>
139        </tr>
140        <tr>
141          <td class="paramkey"></td>
142          <td></td>
143          <td class="paramtype">const char *&nbsp;</td>
144          <td class="paramname"> <em>hostName</em></td><td>&nbsp;</td>
145        </tr>
146        <tr>
147          <td></td>
148          <td>)</td>
149          <td></td><td></td><td width="100%"></td>
150        </tr>
151      </table>
152</div>
153<div class="memdoc">
154
155<p>
156<dl compact><dt><b>Parameters:</b></dt><dd>
157  <table border="0" cellspacing="2" cellpadding="0">
158    <tr><td valign="top"></td><td valign="top"><em>address</em>&nbsp;</td><td>destination to store resolved address </td></tr>
159    <tr><td valign="top"></td><td valign="top"><em>hostName</em>&nbsp;</td><td>host name to lookup </td></tr>
160  </table>
161</dl>
162<dl compact><dt><b>Return values:</b></dt><dd>
163  <table border="0" cellspacing="2" cellpadding="0">
164    <tr><td valign="top"></td><td valign="top"><em>0</em>&nbsp;</td><td>on success </td></tr>
165    <tr><td valign="top"></td><td valign="top"><em>&lt;</em>&nbsp;</td><td>0 on failure </td></tr>
166  </table>
167</dl>
168<dl class="return" compact><dt><b>Returns:</b></dt><dd>the address of the given hostName in address on success </dd></dl>
169
170</div>
171</div><p>
172<hr size="1"><address style="align: right;"><small>Generated on Wed Jun 6 14:33:50 2007 for enet by&nbsp;
173<a href="http://www.doxygen.org/index.html">
174<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
175</body>
176</html>
Note: See TracBrowser for help on using the repository browser.