1998-05-20 10:25:30 -04:00
|
|
|
\section{\class{wxDDEClient}}\label{wxddeclient}
|
|
|
|
|
|
|
|
A wxDDEClient object represents the client part of a client-server DDE
|
1999-01-25 13:33:08 -05:00
|
|
|
(Dynamic Data Exchange) conversation.
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
To create a client which can communicate with a suitable server,
|
|
|
|
you need to derive a class from wxDDEConnection and another from wxDDEClient.
|
|
|
|
The custom wxDDEConnection class will intercept communications in
|
|
|
|
a `conversation' with a server, and the custom wxDDEServer is required
|
2000-07-15 15:51:35 -04:00
|
|
|
so that a user-overridden \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member can return
|
1998-05-20 10:25:30 -04:00
|
|
|
a wxDDEConnection of the required class, when a connection is made.
|
|
|
|
|
1999-01-25 13:33:08 -05:00
|
|
|
This DDE-based implementation is
|
|
|
|
available on Windows only, but a platform-independent, socket-based version
|
|
|
|
of this API is available using \helpref{wxTCPClient}{wxtcpclient}.
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{Derived from}
|
|
|
|
|
1999-01-25 13:33:08 -05:00
|
|
|
wxClientBase\\
|
|
|
|
\helpref{wxObject}{wxobject}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
1999-02-15 15:41:29 -05:00
|
|
|
\wxheading{Include files}
|
|
|
|
|
|
|
|
<wx/dde.h>
|
|
|
|
|
2007-07-28 08:21:03 -04:00
|
|
|
\wxheading{Library}
|
|
|
|
|
|
|
|
\helpref{wxBase}{librarieslist}
|
|
|
|
|
1998-05-20 10:25:30 -04:00
|
|
|
\wxheading{See also}
|
|
|
|
|
1999-01-25 13:33:08 -05:00
|
|
|
\helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEConnection}{wxddeconnection},
|
|
|
|
\helpref{Interprocess communications overview}{ipcoverview}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
|
2004-10-04 11:13:52 -04:00
|
|
|
\membersection{wxDDEClient::wxDDEClient}\label{wxddeclientctor}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\func{}{wxDDEClient}{\void}
|
|
|
|
|
|
|
|
Constructs a client object.
|
|
|
|
|
|
|
|
\membersection{wxDDEClient::MakeConnection}\label{wxddeclientmakeconnection}
|
|
|
|
|
1999-01-25 13:33:08 -05:00
|
|
|
\func{wxConnectionBase *}{MakeConnection}{\param{const wxString\& }{host}, \param{const wxString\& }{service}, \param{const wxString\& }{topic}}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
Tries to make a connection with a server specified by the host
|
|
|
|
(machine name under UNIX, ignored under Windows), service name (must
|
|
|
|
contain an integer port number under UNIX), and topic string. If the
|
|
|
|
server allows a connection, a wxDDEConnection object will be returned.
|
|
|
|
The type of wxDDEConnection returned can be altered by overriding
|
|
|
|
the \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member to return your own
|
|
|
|
derived connection object.
|
|
|
|
|
|
|
|
\membersection{wxDDEClient::OnMakeConnection}\label{wxddeclientonmakeconnection}
|
|
|
|
|
1999-01-25 13:33:08 -05:00
|
|
|
\func{wxConnectionBase *}{OnMakeConnection}{\void}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
The type of \helpref{wxDDEConnection}{wxddeconnection} returned from a \helpref{wxDDEClient::MakeConnection}{wxddeclientmakeconnection} call can
|
|
|
|
be altered by deriving the {\bf OnMakeConnection} member to return your
|
1999-01-25 13:33:08 -05:00
|
|
|
own derived connection object. By default, a wxDDEConnection
|
1998-05-20 10:25:30 -04:00
|
|
|
object is returned.
|
|
|
|
|
|
|
|
The advantage of deriving your own connection class is that it will
|
|
|
|
enable you to intercept messages initiated by the server, such
|
2004-10-04 11:13:52 -04:00
|
|
|
as \helpref{wxDDEConnection::OnAdvise}{wxconnectiononadvise}. You may also want to
|
1998-05-20 10:25:30 -04:00
|
|
|
store application-specific data in instances of the new class.
|
|
|
|
|
2004-10-04 11:13:52 -04:00
|
|
|
\membersection{wxDDEClient::ValidHost}\label{wxddeclientvalidhost}
|
1998-05-20 10:25:30 -04:00
|
|
|
|
|
|
|
\func{bool}{ValidHost}{\param{const wxString\& }{host}}
|
|
|
|
|
2005-04-08 10:34:30 -04:00
|
|
|
Returns \true if this is a valid host name, \false otherwise. This always
|
|
|
|
returns \true under MS Windows.
|
1998-05-20 10:25:30 -04:00
|
|
|
|