X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b80dc5febe0017218e62726b52e32ee418eaa7e3..dbdb39b2d0b8c3359eab1693fd1fc786499f62d7:/docs/latex/wx/sckaddr.tex diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex index 9c04a74b01..e101799615 100644 --- a/docs/latex/wx/sckaddr.tex +++ b/docs/latex/wx/sckaddr.tex @@ -3,18 +3,22 @@ % ---------------------------------------------------------------------------- \section{\class{wxSockAddress}}\label{wxsockaddress} +You are unlikely to need to use this class: only wxSocketBase uses it. + \wxheading{Derived from} \helpref{wxObject}{wxobject} -{\bf Actually, you don't have to use these functions: only wxSocketBase use it.} +\wxheading{Include files} + + \wxheading{See also} -\helpref{wxSocketBase}{wxsocketbase}\\ -\helpref{wxIPV4address}{wxipv4address}\\ -\helpref{wxIPV6address}{wxipv6address}\\ -\helpref{wxunixaddress}{wxunixaddress} +\helpref{wxSocketBase}{wxsocketbase} +%\helpref{wxIPV4address}{wxipv4address}\\ +%\helpref{wxIPV6address}{wxipv6address}\\ +%\helpref{wxunixaddress}{wxunixaddress} % ---------------------------------------------------------------------------- % Members @@ -27,11 +31,13 @@ % \membersection{wxSockAddress::wxSockAddress} + \func{}{wxSockAddress}{\void} Default constructor. \membersection{wxSockAddress::\destruct{wxSockAddress}} + \func{}{\destruct{wxSockAddress}}{\void} Default destructor. @@ -48,6 +54,7 @@ Delete all informations about the address. % Build % \membersection{wxSockAddress::Build} + \func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}} Build a coded socket address. @@ -56,6 +63,7 @@ Build a coded socket address. % Disassemble % \membersection{wxSockAddress::Disassemble} + \func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}} Decode a socket address. {\bf Actually, you don't have to use this @@ -65,6 +73,7 @@ function: only wxSocketBase use it.} % SockAddrLen % \membersection{wxSockAddress::SockAddrLen} + \func{int}{SockAddrLen}{\void}; Returns the length of the socket address. @@ -78,6 +87,10 @@ Returns the length of the socket address. \helpref{wxSockAddress}{wxsockaddress} +\wxheading{Include files} + + + % ---------------------------------------------------------------------------- % MEMBERS % ---------------------------------------------------------------------------- @@ -89,6 +102,7 @@ Returns the length of the socket address. % \membersection{wxIPV4address::Hostname} + \func{bool}{Hostname}{\param{const wxString\&}{ hostname}} Use the specified {\it hostname} for the address. @@ -102,6 +116,7 @@ Returns FALSE if something bad happens (invalid hostname, invalid IP address). % \membersection{wxIPV4address::Hostname} + \func{wxString}{Hostname}{\void} Returns the hostname which matches the IP address. @@ -111,6 +126,7 @@ Returns the hostname which matches the IP address. % \membersection{wxIPV4address::Service} + \func{bool}{Service}{\param{const wxString\&}{ service}} Use the specified {\it service} string for the address. @@ -124,6 +140,7 @@ Returns FALSE if something bad happens (invalid service). % \membersection{wxIPV4address::Service} + \func{bool}{Service}{\param{unsigned short}{ service}} Use the specified {\it service} for the address. @@ -137,6 +154,7 @@ Returns FALSE if something bad happens (invalid service). % \membersection{wxIPV4address::Service} + \func{unsigned short}{Service}{\void} Returns the current service. @@ -146,6 +164,7 @@ Returns the current service. % \membersection{wxIPV4address::LocalHost} + \func{bool}{LocalHost}{\void} Initialize peer host to local host. @@ -153,3 +172,4 @@ Initialize peer host to local host. \wxheading{Return value} Returns FALSE if something bad happens. +