docs/latex/wx/ddeclint.tex

   1 \section{\class{wxDDEClient}}\label{wxddeclient}
   2
   3 A wxDDEClient object represents the client part of a client-server DDE
   4 (Dynamic Data Exchange) conversation.
   5
   6 To create a client which can communicate with a suitable server,
   7 you need to derive a class from wxDDEConnection and another from wxDDEClient.
   8 The custom wxDDEConnection class will intercept communications in
   9 a `conversation' with a server, and the custom wxDDEServer is required
  10 so that a user-overridden \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member can return
  11 a wxDDEConnection of the required class, when a connection is made.
  12
  13 This DDE-based implementation is
  14 available on Windows only, but a platform-independent, socket-based version
  15 of this API is available using \helpref{wxTCPClient}{wxtcpclient}.
  16
  17 \wxheading{Derived from}
  18
  19 wxClientBase\\
  20 \helpref{wxObject}{wxobject}
  21
  22 \wxheading{Include files}
  23
  24 <wx/dde.h>
  25
  26 \wxheading{Library}
  27
  28 \helpref{wxBase}{librarieslist}
  29
  30 \wxheading{See also}
  31
  32 \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEConnection}{wxddeconnection},
  33 \helpref{Interprocess communications overview}{ipcoverview}
  34
  35 \latexignore{\rtfignore{\wxheading{Members}}}
  36
  37 \membersection{wxDDEClient::wxDDEClient}\label{wxddeclientctor}
  38
  39 \func{}{wxDDEClient}{\void}
  40
  41 Constructs a client object.
  42
  43 \membersection{wxDDEClient::MakeConnection}\label{wxddeclientmakeconnection}
  44
  45 \func{wxConnectionBase *}{MakeConnection}{\param{const wxString\& }{host}, \param{const wxString\& }{service}, \param{const wxString\& }{topic}}
  46
  47 Tries to make a connection with a server specified by the host
  48 (machine name under UNIX, ignored under Windows), service name (must
  49 contain an integer port number under UNIX), and topic string. If the
  50 server allows a connection, a wxDDEConnection object will be returned.
  51 The type of wxDDEConnection returned can be altered by overriding
  52 the \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member to return your own
  53 derived connection object.
  54
  55 \membersection{wxDDEClient::OnMakeConnection}\label{wxddeclientonmakeconnection}
  56
  57 \func{wxConnectionBase *}{OnMakeConnection}{\void}
  58
  59 The type of \helpref{wxDDEConnection}{wxddeconnection} returned from a \helpref{wxDDEClient::MakeConnection}{wxddeclientmakeconnection} call can
  60 be altered by deriving the {\bf OnMakeConnection} member to return your
  61 own derived connection object. By default, a wxDDEConnection
  62 object is returned.
  63
  64 The advantage of deriving your own connection class is that it will
  65 enable you to intercept messages initiated by the server, such
  66 as \helpref{wxDDEConnection::OnAdvise}{wxconnectiononadvise}. You may also want to
  67 store application-specific data in instances of the new class.
  68
  69 \membersection{wxDDEClient::ValidHost}\label{wxddeclientvalidhost}
  70
  71 \func{bool}{ValidHost}{\param{const wxString\& }{host}}
  72
  73 Returns \true if this is a valid host name, \false otherwise. This always
  74 returns \true under MS Windows.
  75