autodoc.git/
traditional_manual/
chapter_9.html
Branch:
Tag:
Non-build tags
All tags
No tags
2003-04-23
2003-04-23 09:57:14 by Henrik Grubbström (Grubba) <grubba@grubba.org>
5ffebacf17593c34ab113e84765524527aaebefb (
20
lines) (+
13
/-
7
)
[
Show
|
Annotate
]
Branch:
8.0
Updated documentation for query_address().
Rev: src/modules/files/file.c:1.270
616:
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Get address and port of a socket end-point.</p>
-
<p> This function returns the remote or local address of a socket on the
-
form "x.x.x.x port".</p>
-
<p> If the argument <code>local</code> is not specified, or is <code class='expr'>0</code> (zero),
-
the remote address will be returned. Otherwise, if <code>local</code> is
-
<code class='expr'>1</code>, the local address will be returned.</p>
-
<p> If the file is not a socket, not connected, or some other error
-
occurrs, <code class='expr'>0</code> (zero) will be returned.</p>
+
</dd>
-
+
<dt class='head--doc'><span id='p-local'></span>Parameter <code class='parameter'>local</code></dt>
+
<dd></dd><dd class='body--doc'><p>If the argument <code>local</code> is not specified, or is <code class='expr'>0</code> (zero),
+
the remote end-point will be returned. Otherwise, if <code>local</code> is
+
<code class='expr'>1</code>, the local end-point will be returned.</p>
+
</dd>
+
<dt class='head--doc'>Returns</dt>
+
<dd class='body--doc'><p>This function returns the address and port of a socket end-point
+
on the form <code class='expr'>"x.x.x.x port"</code> (IPv4) or
+
<code class='expr'>"x:x:x:x:x:x:x:x port"</code> (IPv6).</p>
+
<p> If this file is not a socket, is not connected, or some other
+
error occurrs, <code class='expr'>0</code> (zero) will be returned.</p>
+
</dd>
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>connect()</code></p> </dd></dl>