documented UngetWriteBuf overload

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18787 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 0ba4b7638a23996208acd6431e1b0f32d4039dd9..b9cd2f04188645e07a5d0def819979b80a20bdc3 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -970,9 +970,19 @@ Truncate the string to the given length.
 
 \func{void}{UngetWriteBuf}{\void}
 
 
 \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.
 
 \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}
 \membersection{wxString::Upper}\label{wxstringupper}
 
 \constfunc{wxString}{Upper}{\void}