wxConnectionBase\\
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/sckipc.h>
+
\wxheading{Types}
\index{wxIPCFormat}wxIPCFormat is defined as follows:
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxTCPConnection::wxTCPConnection}
+\membersection{wxTCPConnection::wxTCPConnection}\label{wxtcpconnectionctor}
\func{}{wxTCPConnection}{\void}
a buffer and size of the buffer for the connection object to use in
transactions.
-\membersection{wxTCPConnection::Advise}
+\membersection{wxTCPConnection::Advise}\label{wxtcpconnectionadvise}
\func{bool}{Advise}{\param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
Called by the server application to advise the client of a change in
the data associated with the given item. Causes the client
-connection's \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise}
-member to be called. Returns TRUE if successful.
+connection's \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise}
+member to be called. Returns true if successful.
-\membersection{wxTCPConnection::Execute}
+\membersection{wxTCPConnection::Execute}\label{wxtcpconnectionexecute}
\func{bool}{Execute}{\param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
also be used to transfer arbitrary data to the server (similar
to \helpref{wxTCPConnection::Poke}{wxtcpconnectionpoke} in that respect). Causes the
server connection's \helpref{wxTCPConnection::OnExecute}{wxtcpconnectiononexecute} member to be
-called. Returns TRUE if successful.
+called. Returns true if successful.
-\membersection{wxTCPConnection::Disconnect}
+\membersection{wxTCPConnection::Disconnect}\label{wxtcpconnectiondisconnect}
\func{bool}{Disconnect}{\void}
to be sent to the corresponding connection object in the other
program. The default behaviour of {\bf OnDisconnect} is to delete the
connection, but the calling application must explicitly delete its
-side of the connection having called {\bf Disconnect}. Returns TRUE if
+side of the connection having called {\bf Disconnect}. Returns true if
successful.
\membersection{wxTCPConnection::OnAdvise}\label{wxtcpconnectiononadvise}
Message sent to the server application by the client, when the client
wishes to start an `advise loop' for the given topic and item. The
-server can refuse to participate by returning FALSE.
+server can refuse to participate by returning false.
\membersection{wxTCPConnection::OnStopAdvise}\label{wxtcpconnectiononstopadvise}
Message sent to the server application by the client, when the client
wishes to stop an `advise loop' for the given topic and item. The
-server can refuse to stop the advise loop by returning FALSE, although
+server can refuse to stop the advise loop by returning false, although
this doesn't have much meaning in practice.
\membersection{wxTCPConnection::Poke}\label{wxtcpconnectionpoke}
Called by the client application to poke data into the server. Can be
used to transfer arbitrary data to the server. Causes the server
connection's \helpref{wxTCPConnection::OnPoke}{wxtcpconnectiononpoke} member
-to be called. Returns TRUE if successful.
+to be called. Returns true if successful.
\membersection{wxTCPConnection::Request}\label{wxtcpconnectionrequest}
Called by the client application to ask if an advise loop can be started
with the server. Causes the server connection's \helpref{wxTCPConnection::OnStartAdvise}{wxtcpconnectiononstartadvise}\rtfsp
-member to be called. Returns TRUE if the server okays it, FALSE
+member to be called. Returns true if the server okays it, false
otherwise.
\membersection{wxTCPConnection::StopAdvise}\label{wxtcpconnectionstopadvise}
Called by the client application to ask if an advise loop can be
stopped. Causes the server connection's \helpref{wxTCPConnection::OnStopAdvise}{wxtcpconnectiononstopadvise} member
-to be called. Returns TRUE if the server okays it, FALSE otherwise.
+to be called. Returns true if the server okays it, false otherwise.