added null pointer check and assert

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

diff --git a/docs/latex/wx/ipaddr.tex b/docs/latex/wx/ipaddr.tex
index 08e314c1248e8ad5f6d31f045a323528fd83a2cc..ffbd80f3bc4f6d7a4017ceb822da2c0487062fb4 100644 (file)
--- a/docs/latex/wx/ipaddr.tex
+++ b/docs/latex/wx/ipaddr.tex
@@ -10,7 +10,8 @@ is being developed.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxSockAddress}{wxsockaddress}
+\helpref{wxSockAddress}{wxsockaddress}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -25,7 +26,7 @@ is being developed.
 % Hostname
 %
 
 % Hostname
 %
 

-\membersection{wxIPaddress::Hostname}
+\membersection{wxIPaddress::Hostname}\label{wxipaddresshostname}

 
 \func{virtual bool}{Hostname}{\param{const wxString\&}{ hostname}}
 
 
 \func{virtual bool}{Hostname}{\param{const wxString\&}{ hostname}}
 


@@ -37,12 +38,6 @@ or an IP-style address in a format dependent on implementation.
 Returns true on success, false if something goes wrong
 (invalid hostname or invalid IP address).
 
 Returns true on success, false if something goes wrong
 (invalid hostname or invalid IP address).
 

-%
-% Hostname
-%
-
-\membersection{wxIPaddress::Hostname}
-

 \func{virtual wxString}{Hostname}{\void}
 
 Returns the hostname which matches the IP address.
 \func{virtual wxString}{Hostname}{\void}
 
 Returns the hostname which matches the IP address.


@@ -51,7 +46,7 @@ Returns the hostname which matches the IP address.
 % IPAddress
 %
 
 % IPAddress
 %
 

-\membersection{wxIPaddress::IPAddress}
+\membersection{wxIPaddress::IPAddress}\label{wxipaddressipaddress}

 
 \func{virtual wxString}{IPAddress}{\void}
 
 
 \func{virtual wxString}{IPAddress}{\void}
 


@@ -61,7 +56,7 @@ Returns a wxString containing the IP address.
 % Service
 %
 
 % Service
 %
 

-\membersection{wxIPaddress::Service}
+\membersection{wxIPaddress::Service}\label{wxipaddressservice}

 
 \func{virtual bool}{Service}{\param{const wxString\&}{ service}}
 
 
 \func{virtual bool}{Service}{\param{const wxString\&}{ service}}
 


@@ -72,12 +67,6 @@ Set the port to that corresponding to the specified {\it service}.
 Returns true on success, false if something goes wrong
 (invalid service).
 
 Returns true on success, false if something goes wrong
 (invalid service).
 

-%
-% Service
-%
-
-\membersection{wxIPaddress::Service}
-

 \func{virtual bool}{Service}{\param{unsigned short}{ service}}
 
 Set the port to that corresponding to the specified {\it service}.
 \func{virtual bool}{Service}{\param{unsigned short}{ service}}
 
 Set the port to that corresponding to the specified {\it service}.


@@ -87,12 +76,6 @@ Set the port to that corresponding to the specified {\it service}.
 Returns true on success, false if something goes wrong
 (invalid service).
 
 Returns true on success, false if something goes wrong
 (invalid service).
 

-%
-% Service
-%
-
-\membersection{wxIPaddress::Service}
-

 \func{virtual unsigned short}{Service}{\void}
 
 Returns the current service.
 \func{virtual unsigned short}{Service}{\void}
 
 Returns the current service.


@@ -116,11 +99,28 @@ On IPV6 implementations, ::
 
 Returns true on success, false if something went wrong.
 
 
 Returns true on success, false if something went wrong.
 

+%
+% BroadcastAddress
+%
+
+\membersection{wxIPaddress::BroadcastAddress}\label{wxipaddressbroadcastaddress}
+
+\func{virtual bool}{BroadcastAddress}{\void}
+
+Internally, this is the same as setting the IP address
+to {\bf INADDR\_BROADCAST}.
+
+On IPV4 implementations, 255.255.255.255
+
+\wxheading{Return value}
+
+Returns true on success, false if something went wrong.
+

 %
 % LocalHost
 %
 
 %
 % LocalHost
 %
 

-\membersection{wxIPaddress::LocalHost}\label{wxIPaddresslocalhost}
+\membersection{wxIPaddress::LocalHost}\label{wxipaddresslocalhost}

 
 \func{virtual bool}{LocalHost}{\void}
 
 
 \func{virtual bool}{LocalHost}{\void}
 


@@ -134,7 +134,7 @@ On IPV6 implementations, ::1
 
 Returns true on success, false if something went wrong.
 
 
 Returns true on success, false if something went wrong.
 

-\membersection{wxIPaddress::IsLocalHost}\label{wxIPaddressislocalhost}
+\membersection{wxIPaddress::IsLocalHost}\label{wxipaddressislocalhost}

 
 \func{virtual bool}{IsLocalHost}{\void}
 
 
 \func{virtual bool}{IsLocalHost}{\void}