documented UngetWriteBuf overload

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18787 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2003-01-17 11:04:58 +00:00
parent f81127c568
commit 448025b0dc

View File

@@ -970,9 +970,19 @@ Truncate the string to the given length.
\func{void}{UngetWriteBuf}{\void}
Puts the string back into a reasonable state, after
\func{void}{UngetWriteBuf}{\param{size\_t }{len}}
Puts the string back into a reasonable state (in which it can be used
normally), after
\rtfsp\helpref{wxString::GetWriteBuf}{wxstringgetwritebuf} was called.
The version of the function without the {\it len} parameter will calculate the
new string length itself assuming that the string is terminated by the first
{\tt NUL} character in it while the second one will use the specified length
and thus is the only version which should be used with the strings with
embedded {\tt NUL}s (it is also slightly more efficient as {\tt strlen()}
doesn't have to be called).
\membersection{wxString::Upper}\label{wxstringupper}
\constfunc{wxString}{Upper}{\void}