]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/ipvaddr.tex
added wxGetPasswordFromUser(), dialogs sample shows it, documented it
[wxWidgets.git] / docs / latex / wx / ipvaddr.tex
CommitLineData
ca5c8b2d
JS
1% ----------------------------------------------------------------------------
2% CLASS: wxIPV4address
3% ----------------------------------------------------------------------------
4\section{\class{wxIPV4address}}\label{wxipv4address}
5
6\wxheading{Derived from}
7
8\helpref{wxSockAddress}{wxsockaddress}
9
10\wxheading{Include files}
11
12<wx/socket.h>
13
14% ----------------------------------------------------------------------------
15% MEMBERS
16% ----------------------------------------------------------------------------
17
18\latexignore{\rtfignore{\wxheading{Members}}}
19
20%
21% Hostname
22%
23
24\membersection{wxIPV4address::Hostname}
25
26\func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
27
ec780532
GRG
28Set the address to {\it hostname}, which can be a host name
29or an IP-style address in dot notation (a.b.c.d)
ca5c8b2d
JS
30
31\wxheading{Return value}
32
ec780532
GRG
33Returns TRUE on success, FALSE if something goes wrong
34(invalid hostname or invalid IP address).
ca5c8b2d
JS
35
36%
37% Hostname
38%
39
40\membersection{wxIPV4address::Hostname}
41
42\func{wxString}{Hostname}{\void}
43
44Returns the hostname which matches the IP address.
45
46%
47% Service
48%
49
50\membersection{wxIPV4address::Service}
51
52\func{bool}{Service}{\param{const wxString\&}{ service}}
53
ec780532 54Set the port to that corresponding to the specified {\it service}.
ca5c8b2d
JS
55
56\wxheading{Return value}
57
ec780532
GRG
58Returns TRUE on success, FALSE if something goes wrong
59(invalid service).
ca5c8b2d
JS
60
61%
62% Service
63%
64
65\membersection{wxIPV4address::Service}
66
67\func{bool}{Service}{\param{unsigned short}{ service}}
68
ec780532 69Set the port to that corresponding to the specified {\it service}.
ca5c8b2d
JS
70
71\wxheading{Return value}
72
ec780532
GRG
73Returns TRUE on success, FALSE if something goes wrong
74(invalid service).
ca5c8b2d
JS
75
76%
77% Service
78%
79
80\membersection{wxIPV4address::Service}
81
82\func{unsigned short}{Service}{\void}
83
84Returns the current service.
85
ec780532
GRG
86%
87% AnyAddress
88%
89
90\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
91
92\func{bool}{AnyAddress}{\void}
93
94Set address to any of the addresses of the current machine. Whenever
95possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
96as this correctly handles multi-homed hosts and avoids other small
97problems. Internally, this is the same as setting the IP address
98to {\bf INADDR\_ANY}.
99
100\wxheading{Return value}
101
102Returns TRUE on success, FALSE if something went wrong.
103
104
ca5c8b2d
JS
105%
106% LocalHost
107%
108
ec780532 109\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
ca5c8b2d
JS
110
111\func{bool}{LocalHost}{\void}
112
ec780532
GRG
113Set address to "localhost" (127.0.0.1). Whenever possible, use the
114\helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress},
115function instead of this one, as this will correctly handle multi-homed
116hosts and avoid other small problems.
ca5c8b2d
JS
117
118\wxheading{Return value}
119
ec780532 120Returns TRUE on success, FALSE if something went wrong.
ca5c8b2d 121