Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clarified the return value of MB2WC/WC2MB

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_4_BRANCH@17632 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2002-10-26 20:18:46 +00:00
parent ed0fb5f1dc
commit a068a1ce8d
1 changed files with 25 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/latex/wx/mbconv.tex
View File

@@ -37,15 +37,36 @@ Constructor.
\constfunc{virtual size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
Converts from multibyte encoding to Unicode, using the libc routine mbstowcs()
(this is overridden by derived classes). Returns the size of the destination buffer.
Converts from a string {\it psz} in multibyte encoding to Unicode putting the
output into the buffer {\it buf} of the size {\it n} (in wide characters, not
bytes). If {\it buf} is {\tt NULL}, nothing is written to it but the length of
the string which would result from the conversion is calculated and returned.
Note that this is the length and not size, i.e. the returned value does
{\bf not} include the trailing NUL. But when the function is called with a
non-{\tt NULL} buffer, the {\it n} parameter should be the size of the buffer
and so it {\bf should} take into account the trailing NUL.
\wxheading{Parameters}
\docparam{buf}{the output buffer, may be {\tt NULL} if the caller is only
interested in the length of the resulting string}
\docparam{psz}{the {\tt NUL}-terminated input string, cannot be {\tt NULL}}
\docparam{n}{the size of the output buffer, ignored if {\it buf} is {\tt NULL}}
\wxheading{Return value}
The length of the converted string.
\membersection{wxMBConv::WC2MB}\label{wxmbconvwc2mb}
\constfunc{virtual size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
Converts from Unicode to multibyte encoding, using the libc routine wcstombs()
(this is overridden by derived classes). Returns the size of the destination buffer.
Converts from Unicode to multibyte encoding. The semantics of this function
(including the return value meaning) is the same as for
\helpref{MB2WC}{wxmbconvmb2wc}.
\membersection{wxMBConv::cMB2WC}\label{wxmbconvcmb2wc}