X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec78053243b4d5ee07b14f8bcc71b03c27b118d5..3db5226517a63bcdc983e638f1a312764fe1312f:/docs/latex/wx/ipvaddr.tex diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex index b982f7429f..0f314073a6 100644 --- 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,14 +14,13 @@ % ---------------------------------------------------------------------------- % MEMBERS % ---------------------------------------------------------------------------- - \latexignore{\rtfignore{\wxheading{Members}}} % % Hostname % -\membersection{wxIPV4address::Hostname} +\membersection{wxIPV4address::Hostname}\label{wxipv4addresshostname} \func{bool}{Hostname}{\param{const wxString\&}{ hostname}} @@ -30,24 +29,28 @@ or an IP-style address in dot notation (a.b.c.d) \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +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}} @@ -55,30 +58,18 @@ Set the port to that corresponding to the specified {\it service}. \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +Returns true on success, false if something goes wrong (invalid service). -% -% Service -% - -\membersection{wxIPV4address::Service} - \func{bool}{Service}{\param{unsigned short}{ service}} Set the port to that corresponding to the specified {\it service}. \wxheading{Return value} -Returns TRUE on success, FALSE if something goes wrong +Returns true on success, false if something goes wrong (invalid service). -% -% Service -% - -\membersection{wxIPV4address::Service} - \func{unsigned short}{Service}{\void} Returns the current service. @@ -99,8 +90,7 @@ to {\bf INADDR\_ANY}. \wxheading{Return value} -Returns TRUE on success, FALSE if something went wrong. - +Returns true on success, false if something went wrong. % % LocalHost @@ -110,12 +100,12 @@ Returns TRUE on success, FALSE if something went wrong. \func{bool}{LocalHost}{\void} -Set address to "localhost" (127.0.0.1). Whenever possible, use the +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 TRUE on success, FALSE if something went wrong. +Returns true on success, false if something went wrong.