Doc corrections; added HelpGen project files

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

\section{\class{wxDDEServer}}\label{wxddeserver}

A wxDDEServer object represents the server part of a client-server DDE
(Dynamic Data Exchange) conversation.

This DDE-based implementation is
available on Windows only, but a platform-independent, socket-based version
of this API is available using \helpref{wxTCPServer}{wxtcpserver}.

\wxheading{Derived from}

wxServerBase

\wxheading{Include files}

<wx/dde.h>

\wxheading{See also}

\helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, \helpref{IPC overview}{ipcoverview}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxDDEServer::wxDDEServer}

\func{}{wxDDEServer}{\void}

Constructs a server object.

\membersection{wxDDEServer::Create}

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

Registers the server using the given service name. Under UNIX, the
string must contain an integer id which is used as an Internet port
number. FALSE is returned if the call failed (for example, the port
number is already in use).

\membersection{wxDDEServer::OnAcceptConnection}\label{wxddeserveronacceptconnection}

\func{virtual wxConnectionBase *}{OnAcceptConnection}{\param{const wxString\& }{topic}}

When a client calls {\bf MakeConnection}, the server receives the
message and this member is called. The application should derive a
member to intercept this message and return a connection object of
either the standard wxDDEConnection type, or of a user-derived type. If the
topic is ``STDIO'', the application may wish to refuse the connection.
Under UNIX, when a server is created the OnAcceptConnection message is
always sent for standard input and output, but in the context of DDE
messages it doesn't make a lot of sense.