define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

[wxWidgets.git] / docs / latex / wx / ipvaddr.tex

diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex
index 07ae2e0a74c9a35d41c73a7fa7236f1948e6666b..0f314073a654ee708d7799c44f02230b3f2ac0c5 100644 (file)
--- a/docs/latex/wx/ipvaddr.tex
+++ b/docs/latex/wx/ipvaddr.tex
@@ -5,7 +5,7 @@
 
 \wxheading{Derived from}
 
-\helpref{wxSockAddress}{wxsockaddress}
+\helpref{wxIPaddress}{wxipaddress}
 
 \wxheading{Include files}
 
@@ -14,82 +14,98 @@
 % ----------------------------------------------------------------------------
 % MEMBERS
 % ----------------------------------------------------------------------------
-
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % Hostname
 %
 
-\membersection{wxIPV4address::Hostname}
+\membersection{wxIPV4address::Hostname}\label{wxipv4addresshostname}
 
 \func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
 
-Use the specified {\it hostname} for the address.
+Set the address to {\it hostname}, which can be a host name
+or an IP-style address in dot notation (a.b.c.d)
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid hostname, invalid IP address). 
+Returns true on success, false if something goes wrong
+(invalid hostname or invalid IP address).
+
+\func{wxString}{Hostname}{\void}
+
+Returns the hostname which matches the IP address.
 
 %
-% Hostname
+% IPAddress
 %
 
-\membersection{wxIPV4address::Hostname}
+\membersection{wxIPV4address::IPAddress}\label{wxipv4addressipaddress}
 
-\func{wxString}{Hostname}{\void}
+\func{wxString}{IPAddress}{\void}
 
-Returns the hostname which matches the IP address.
+Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
 
 %
 % Service
 %
 
-\membersection{wxIPV4address::Service}
+\membersection{wxIPV4address::Service}\label{wxipv4addressservice}
 
 \func{bool}{Service}{\param{const wxString\&}{ service}}
 
-Use the specified {\it service} string for the address.
+Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid service).
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
+Returns true on success, false if something goes wrong
+(invalid service).
 
 \func{bool}{Service}{\param{unsigned short}{ service}}
 
-Use the specified {\it service} for the address.
+Set the port to that corresponding to the specified {\it service}.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens (invalid service).
+Returns true on success, false if something goes wrong
+(invalid service).
+
+\func{unsigned short}{Service}{\void}
+
+Returns the current service.
 
 %
-% Service
+% AnyAddress
 %
 
-\membersection{wxIPV4address::Service}
+\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
 
-\func{unsigned short}{Service}{\void}
+\func{bool}{AnyAddress}{\void}
 
-Returns the current service.
+Set address to any of the addresses of the current machine. Whenever
+possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
+as this correctly handles multi-homed hosts and avoids other small
+problems. Internally, this is the same as setting the IP address
+to {\bf INADDR\_ANY}.
+
+\wxheading{Return value}
+
+Returns true on success, false if something went wrong.
 
 %
 % LocalHost
 %
 
-\membersection{wxIPV4address::LocalHost}
+\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
 
 \func{bool}{LocalHost}{\void}
 
-Initialize peer host to local host.
+Set address to localhost (127.0.0.1). Whenever possible, use the 
+\helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress},
+function instead of this one, as this will correctly handle multi-homed
+hosts and avoid other small problems.
 
 \wxheading{Return value}
 
-Returns FALSE if something bad happens.
+Returns true on success, false if something went wrong.