From 448025b0dc94dfb2aa4f99c6ba0525f4f4356dea Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 17 Jan 2003 11:04:58 +0000 Subject: [PATCH] documented UngetWriteBuf overload git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18787 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/wxstring.tex | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 0ba4b7638a..b9cd2f0418 100644 --- 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} -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} -- 2.45.2