X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec78053243b4d5ee07b14f8bcc71b03c27b118d5..4a82116e2ee3060ecdb8a451403280f54be93372:/docs/latex/wx/ipvaddr.tex diff --git a/docs/latex/wx/ipvaddr.tex b/docs/latex/wx/ipvaddr.tex index b982f7429f..fef4c521a7 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,7 +14,6 @@ % ---------------------------------------------------------------------------- % MEMBERS % ---------------------------------------------------------------------------- - \latexignore{\rtfignore{\wxheading{Members}}} % @@ -30,7 +29,7 @@ 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). % @@ -43,6 +42,16 @@ Returns TRUE on success, FALSE if something goes wrong Returns the hostname which matches the IP address. +% +% IPAddress +% + +\membersection{wxIPV4address::IPAddress} + +\func{wxString}{IPAddress}{\void} + +Returns a wxString containing the IP address in dot quad (127.0.0.1) format. + % % Service % @@ -55,7 +64,7 @@ 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). % @@ -70,7 +79,7 @@ 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). % @@ -99,8 +108,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 +118,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.