X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b2cf617cb8160a92696f1421675963aa00cb0c2b..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/tcpconn.tex diff --git a/docs/latex/wx/tcpconn.tex b/docs/latex/wx/tcpconn.tex index bf4dcf59cf..a530e47064 100644 --- a/docs/latex/wx/tcpconn.tex +++ b/docs/latex/wx/tcpconn.tex @@ -58,7 +58,7 @@ enum wxIPCFormat \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxTCPConnection::wxTCPConnection} +\membersection{wxTCPConnection::wxTCPConnection}\label{wxtcpconnectionctor} \func{}{wxTCPConnection}{\void} @@ -76,16 +76,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{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. +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}} @@ -93,9 +93,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{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} @@ -104,7 +104,7 @@ program; it causes the \helpref{wxTCPConnection::OnDisconnect}{wxtcpconnectionon 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} @@ -152,7 +152,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{wxTCPConnection::OnStopAdvise}\label{wxtcpconnectiononstopadvise} @@ -160,7 +160,7 @@ 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{wxTCPConnection::Poke}\label{wxtcpconnectionpoke} @@ -170,7 +170,7 @@ this doesn't have much meaning in practice. 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} @@ -187,7 +187,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{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} @@ -196,5 +196,5 @@ otherwise. 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.