another patch bring the docs more up to date (patch 1717776)

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

% ----------------------------------------------------------------------------
% CLASS: wxSockAddress
% ----------------------------------------------------------------------------
\section{\class{wxSockAddress}}\label{wxsockaddress}

You are unlikely to need to use this class: only wxSocketBase uses it.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/socket.h>

\wxheading{See also}

\helpref{wxSocketBase}{wxsocketbase}
\helpref{wxIPaddress}{wxipaddress}
\helpref{wxIPV4address}{wxipv4address}

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

%
% ctor/dtor
%
\membersection{wxSockAddress::wxSockAddress}\label{wxsockaddressctor}

\func{}{wxSockAddress}{\void}

Default constructor.

\membersection{wxSockAddress::\destruct{wxSockAddress}}\label{wxsockaddressdtor}

\func{}{\destruct{wxSockAddress}}{\void}

Default destructor.

%
% Clear
%
\membersection{wxSockAddress::Clear}\label{wxsockaddressclear}

\func{void}{Clear}{\void}

Delete all informations about the address.

%
% SockAddrLen
%
\membersection{wxSockAddress::SockAddrLen}\label{wxsockaddresssockaddrlen}

\func{int}{SockAddrLen}{\void}

Returns the length of the socket address.