added vendor display name (for consistency with app display name &c) (patch 1831303)

[wxWidgets.git] / docs / latex / wx / csconv.tex

diff --git a/docs/latex/wx/csconv.tex b/docs/latex/wx/csconv.tex
index 579613615358c006d9b77b3e9de5c9fbb33dae2f..b26bef4ced19c822b26f6ff5d77eecd43330c3bc 100644 (file)
--- a/docs/latex/wx/csconv.tex
+++ b/docs/latex/wx/csconv.tex
@@ -17,6 +17,10 @@ default user character set.
 
 <wx/strconv.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxMBConv}{wxmbconv}, 
@@ -29,11 +33,11 @@ default user character set.
 
 \func{}{wxCSConv}{\param{const wxChar* }{charset}}
 
-\func{}{wxCSConv}{\param{wxFontEncoding}{encoding}}
+\func{}{wxCSConv}{\param{wxFontEncoding }{encoding}}
 
 Constructor. You may specify either the name of the character set you want to
-convert from/to or an encoding constant. If the character set name is not
-recognized, ISO 8859-1 is used as fall back.
+convert from/to or an encoding constant. If the character set name (or the
+encoding) is not recognized, ISO 8859-1 is used as fall back.
 
 
 \membersection{wxCSConv::\destruct{wxCSConv}}\label{wxcsconvdtor}
@@ -43,16 +47,29 @@ recognized, ISO 8859-1 is used as fall back.
 Destructor frees any resources needed to perform the conversion.
 
 
+\membersection{wxCSConv::IsOk}\label{wxcsconvisok}
+
+\constfunc{bool}{IsOk}{\void}
+
+Returns \true if the charset (or the encoding) given at constructor is really
+available to use. Returns \false if ISO 8859-1 will be used instead.
+
+Note this does \emph{not} mean that a given string will be correctly converted.
+A malformed string may still make conversion functions return \texttt{wxCONV\_FAILED}.
+
+\newsince{2.8.2}
+
+
 \membersection{wxCSConv::MB2WC}\label{wxcsconvmb2wc}
 
 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
 
-Converts from the selected character set to Unicode. Returns the size of the destination buffer.
+Converts from the selected character set to Unicode. Returns length of string written to destination buffer.
 
 
 \membersection{wxCSConv::WC2MB}\label{wxcsconvwc2mb}
 
 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
 
-Converts from Unicode to the selected character set. Returns the size of the destination buffer.
+Converts from Unicode to the selected character set. Returns length of string written to destination buffer.