docs/latex/wx/ipvaddr.tex

   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
  28 Use the specified {\it hostname} for the address.
  29
  30 \wxheading{Return value}
  31
  32 Returns FALSE if something bad happens (invalid hostname, invalid IP address).
  33
  34 %
  35 % Hostname
  36 %
  37
  38 \membersection{wxIPV4address::Hostname}
  39
  40 \func{wxString}{Hostname}{\void}
  41
  42 Returns the hostname which matches the IP address.
  43
  44 %
  45 % Service
  46 %
  47
  48 \membersection{wxIPV4address::Service}
  49
  50 \func{bool}{Service}{\param{const wxString\&}{ service}}
  51
  52 Use the specified {\it service} string for the address.
  53
  54 \wxheading{Return value}
  55
  56 Returns FALSE if something bad happens (invalid service).
  57
  58 %
  59 % Service
  60 %
  61
  62 \membersection{wxIPV4address::Service}
  63
  64 \func{bool}{Service}{\param{unsigned short}{ service}}
  65
  66 Use the specified {\it service} for the address.
  67
  68 \wxheading{Return value}
  69
  70 Returns FALSE if something bad happens (invalid service).
  71
  72 %
  73 % Service
  74 %
  75
  76 \membersection{wxIPV4address::Service}
  77
  78 \func{unsigned short}{Service}{\void}
  79
  80 Returns the current service.
  81
  82 %
  83 % LocalHost
  84 %
  85
  86 \membersection{wxIPV4address::LocalHost}
  87
  88 \func{bool}{LocalHost}{\void}
  89
  90 Initialize peer host to local host.
  91
  92 \wxheading{Return value}
  93
  94 Returns FALSE if something bad happens.
  95