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

% ----------------------------------------------------------------------------
% CLASS: wxIPV4address
% ----------------------------------------------------------------------------
\section{\class{wxIPV4address}}\label{wxipv4address}

\wxheading{Derived from}

\helpref{wxIPaddress}{wxipaddress}

\wxheading{Include files}

<wx/socket.h>

% ----------------------------------------------------------------------------
% MEMBERS
% ----------------------------------------------------------------------------
\latexignore{\rtfignore{\wxheading{Members}}}

%
% Hostname
%

\membersection{wxIPV4address::Hostname}\label{wxipv4addresshostname}

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

Set the address to {\it hostname}, which can be a host name
or an IP-style address in dot notation (a.b.c.d)

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid hostname or invalid IP address).

\func{wxString}{Hostname}{\void}

Returns the hostname which matches the IP address.

%
% IPAddress
%

\membersection{wxIPV4address::IPAddress}\label{wxipv4addressipaddress}

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

Returns a wxString containing the IP address in dot quad (127.0.0.1) format.

%
% Service
%

\membersection{wxIPV4address::Service}\label{wxipv4addressservice}

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

Set the port to that corresponding to the specified {\it service}.

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid service).

\func{bool}{Service}{\param{unsigned short}{ service}}

Set the port to that corresponding to the specified {\it service}.

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid service).

\func{unsigned short}{Service}{\void}

Returns the current service.

%
% AnyAddress
%

\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}

\func{bool}{AnyAddress}{\void}

Set address to any of the addresses of the current machine. Whenever
possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
as this correctly handles multi-homed hosts and avoids other small
problems. Internally, this is the same as setting the IP address
to {\bf INADDR\_ANY}.

\wxheading{Return value}

Returns true on success, false if something went wrong.

%
% LocalHost
%

\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}

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

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