]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/sckaddr.tex
Whole bunch of minor doc updates from an external patch.
[wxWidgets.git] / docs / latex / wx / sckaddr.tex
1 % ----------------------------------------------------------------------------
2 % CLASS: wxSockAddress
3 % ----------------------------------------------------------------------------
4 \section{\class{wxSockAddress}}\label{wxsockaddress}
5
6 You are unlikely to need to use this class: only wxSocketBase uses it.
7
8 \wxheading{Derived from}
9
10 \helpref{wxObject}{wxobject}
11
12 \wxheading{Include files}
13
14 <wx/socket.h>
15
16 \wxheading{See also}
17
18 \helpref{wxSocketBase}{wxsocketbase}
19 \helpref{wxIPaddress}{wxipaddress}
20 \helpref{wxIPV4address}{wxipv4address}
21
22 % ----------------------------------------------------------------------------
23 % Members
24 % ----------------------------------------------------------------------------
25 \latexignore{\rtfignore{\wxheading{Members}}}
26
27 %
28 % ctor/dtor
29 %
30 \membersection{wxSockAddress::wxSockAddress}\label{wxsockaddressctor}
31
32 \func{}{wxSockAddress}{\void}
33
34 Default constructor.
35
36 \membersection{wxSockAddress::\destruct{wxSockAddress}}\label{wxsockaddressdtor}
37
38 \func{}{\destruct{wxSockAddress}}{\void}
39
40 Default destructor.
41
42 %
43 % Clear
44 %
45 \membersection{wxSockAddress::Clear}\label{wxsockaddressclear}
46
47 \func{void}{Clear}{\void}
48
49 Delete all informations about the address.
50
51 %
52 % SockAddrLen
53 %
54 \membersection{wxSockAddress::SockAddrLen}\label{wxsockaddresssockaddrlen}
55
56 \func{int}{SockAddrLen}{\void}
57
58 Returns the length of the socket address.
59