Blind fix for typo in 50972.

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

diff --git a/docs/latex/wx/ddeconn.tex b/docs/latex/wx/ddeconn.tex
index 0be17834bcf5997be9dbc424d5b4790ee3a6f79d..a1992da586bf60a70be23ac67d361487ee0c051b 100644 (file)
--- a/docs/latex/wx/ddeconn.tex
+++ b/docs/latex/wx/ddeconn.tex
@@ -25,6 +25,10 @@ wxConnectionBase\\
 
 <wx/dde.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{Types}
 
 \index{wxIPCFormat}wxIPCFormat is defined as follows:
@@ -45,10 +49,17 @@ enum wxIPCFormat
   wxIPC_PENDATA =          10,
   wxIPC_RIFF =             11,
   wxIPC_WAVE =             12,
-  wxIPC_UNICODETEXT =      13,
+  wxIPC_UTF16TEXT =        13, /* CF_UNICODE */
   wxIPC_ENHMETAFILE =      14,
   wxIPC_FILENAME =         15, /* CF_HDROP */
   wxIPC_LOCALE =           16,
+  wxIPC_UTF8TEXT =         17,
+  wxIPC_UTF32TEXT =        18,
+#if SIZEOF_WCHAR_T == 2
+  wxIPC_UNICODETEXT =      wxIPC_UTF16TEXT,
+#elif SIZEOF_WCHAR_T == 4
+  wxIPC_UNICODETEXT =      wxIPC_UTF32TEXT,
+#endif
   wxIPC_PRIVATE =          20
 };
 \end{verbatim}
@@ -59,11 +70,11 @@ enum wxIPCFormat
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxDDEConnection::wxDDEConnection}
+\membersection{wxDDEConnection::wxDDEConnection}\label{wxddeconnectionctor}
 
 \func{}{wxDDEConnection}{\void}
 
-\func{}{wxDDEConnection}{\param{char* }{buffer}, \param{int}{ size}}
+\func{}{wxDDEConnection}{\param{void* }{buffer}, \param{size\_t}{ size}}
 
 Constructs a connection object. If no user-defined connection object is
 to be derived from wxDDEConnection, then the constructor should not be
@@ -77,26 +88,38 @@ 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{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
 
-\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{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const wxString& }{data}}
 
 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}\label{wxddeconnectionexecute}
 
-\membersection{wxDDEConnection::Execute}
+\func{bool}{Execute}{\param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
 
-\func{bool}{Execute}{\param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
+\func{bool}{Execute}{\param{const char* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Execute}{\param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Execute}{\param{const wxString& }{data}}
 
 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}
 
@@ -105,12 +128,12 @@ 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}
 
-\func{virtual bool}{OnAdvise}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnAdvise}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the client application when the server notifies it of a
 change in the data associated with the given item.
@@ -125,7 +148,7 @@ to delete the connection object.
 
 \membersection{wxDDEConnection::OnExecute}\label{wxddeconnectiononexecute}
 
-\func{virtual bool}{OnExecute}{\param{const wxString\& }{topic}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnExecute}{\param{const wxString\& }{topic}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat}{ format}}
 
 Message sent to the server application when the client notifies it to
 execute the given data. Note that there is no item associated with
@@ -133,14 +156,14 @@ this message.
 
 \membersection{wxDDEConnection::OnPoke}\label{wxddeconnectiononpoke}
 
-\func{virtual bool}{OnPoke}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnPoke}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the server application when the client notifies it to
 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 void*}{OnRequest}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{size\_t * }{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the server application when the client
 calls \helpref{wxDDEConnection::Request}{wxddeconnectionrequest}. The server
@@ -153,7 +176,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}
 
@@ -161,21 +184,27 @@ 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 void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const char* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const wxString& }{data}}
 
 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}
 
-\func{char*}{Request}{\param{const wxString\& }{item}, \param{int *}{size}, \param{wxIPCFormat}{ format = wxIPC\_TEXT}}
+\func{const void*}{Request}{\param{const wxString\& }{item}, \param{size\_t *}{size}, \param{wxIPCFormat }{format = wxIPC\_TEXT}}
 
 Called by the client application to request data from the server. Causes
 the server connection's \helpref{wxDDEConnection::OnRequest}{wxddeconnectiononrequest} member to be called. Returns a
@@ -188,7 +217,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}
@@ -197,6 +226,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.