X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e2a6f23364aefcd5095dc6558e3ab8144363fa96..ab9717339232a7a728dea666c59b73fd6ac78dd3:/docs/latex/wx/ddeconn.tex diff --git a/docs/latex/wx/ddeconn.tex b/docs/latex/wx/ddeconn.tex index 5a197e708d..8cfe495227 100644 --- a/docs/latex/wx/ddeconn.tex +++ b/docs/latex/wx/ddeconn.tex @@ -21,6 +21,14 @@ of this API is available using \helpref{wxTCPConnection}{wxtcpconnection}. wxConnectionBase\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Types} \index{wxIPCFormat}wxIPCFormat is defined as follows: @@ -55,7 +63,7 @@ enum wxIPCFormat \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxDDEConnection::wxDDEConnection} +\membersection{wxDDEConnection::wxDDEConnection}\label{wxddeconnectionctor} \func{}{wxDDEConnection}{\void} @@ -73,16 +81,16 @@ associated with the connection. Otherwise, the programmer must provide a a buffer and size of the buffer for the connection object to use in transactions. -\membersection{wxDDEConnection::Advise} +\membersection{wxDDEConnection::Advise}\label{wxddeconnectionadvise} -\func{bool}{Advise}{\param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}} +\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const 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{wxDDEConnection::OnAdvise}{wxddeconnectiononadvise} -member to be called. Returns TRUE if successful. +member to be called. Returns true if successful. -\membersection{wxDDEConnection::Execute} +\membersection{wxDDEConnection::Execute}\label{wxddeconnectionexecute} \func{bool}{Execute}{\param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}} @@ -90,9 +98,9 @@ Called by the client application to execute a command on the server. Can also be used to transfer arbitrary data to the server (similar to \helpref{wxDDEConnection::Poke}{wxddeconnectionpoke} in that respect). Causes the server connection's \helpref{wxDDEConnection::OnExecute}{wxddeconnectiononexecute} member to be -called. Returns TRUE if successful. +called. Returns true if successful. -\membersection{wxDDEConnection::Disconnect} +\membersection{wxDDEConnection::Disconnect}\label{wxddeconnectiondisconnect} \func{bool}{Disconnect}{\void} @@ -101,7 +109,7 @@ program; it causes the \helpref{wxDDEConnection::OnDisconnect}{wxddeconnectionon 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{wxDDEConnection::OnAdvise}\label{wxddeconnectiononadvise} @@ -136,7 +144,7 @@ accept the given data. \membersection{wxDDEConnection::OnRequest}\label{wxddeconnectiononrequest} -\func{virtual char*}{OnRequest}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{int *}{size}, \param{wxIPCFormat}{ format}} +\func{virtual const char*}{OnRequest}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{int *}{size}, \param{wxIPCFormat}{ format}} Message sent to the server application when the client calls \helpref{wxDDEConnection::Request}{wxddeconnectionrequest}. The server @@ -149,7 +157,7 @@ or NULL to indicate no data. 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{wxDDEConnection::OnStopAdvise}\label{wxddeconnectiononstopadvise} @@ -157,17 +165,17 @@ server can refuse to participate by returning FALSE. 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{wxDDEConnection::Poke}\label{wxddeconnectionpoke} -\func{bool}{Poke}{\param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}} +\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}} 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{wxDDEConnection::OnPoke}{wxddeconnectiononpoke} member -to be called. Returns TRUE if successful. +to be called. Returns true if successful. \membersection{wxDDEConnection::Request}\label{wxddeconnectionrequest} @@ -184,7 +192,7 @@ successful, NULL otherwise. Called by the client application to ask if an advise loop can be started with the server. Causes the server connection's \helpref{wxDDEConnection::OnStartAdvise}{wxddeconnectiononstartadvise}\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{wxDDEConnection::StopAdvise}\label{wxddeconnectionstopadvise} @@ -193,6 +201,5 @@ otherwise. Called by the client application to ask if an advise loop can be stopped. Causes the server connection's \helpref{wxDDEConnection::OnStopAdvise}{wxddeconnectiononstopadvise} 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.