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

%
% automatically generated by HelpGen from
% ../include/wx/strconv.h at 25/Mar/00 10:20:56
%

\section{\class{wxMBConvFile}}\label{wxmbconvfile}

This class converts file names between filesystem multibyte encoding and
Unicode. It has one predefined instance, {\bf wxConvFile}.
Since some platforms (e.g. Win32) use Unicode in the filenames,
and others (e.g. Unix) use multibyte encodings, this class should only
be used directly if wxMBFILES is defined to 1. A convenience macro,
wxFNCONV, is defined to wxConvFile.cWX2MB in this case. You could use it
like this:

\begin{verbatim}
wxChar *name = wxT("rawfile.doc");
FILE *fil = fopen(wxFNCONV(name), "r");
\end{verbatim}

(although it would be better to use wxFopen(name, wxT("r")) in this case.)

\wxheading{Derived from}

\helpref{wxMBConv}{wxmbconv}

\wxheading{Include files}

<wx/strconv.h>

\wxheading{See also}

\helpref{wxMBConv classes overview}{mbconvclasses}

\latexignore{\rtfignore{\wxheading{Members}}}


\membersection{wxMBConvFile::MB2WC}\label{wxmbconvfilemb2wc}

\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}

Converts from multibyte filename encoding to Unicode. Returns the size of the destination buffer.

\membersection{wxMBConvFile::WC2MB}\label{wxmbconvfilewc2mb}

\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}

Converts from Unicode to multibyte filename encoding. Returns the size of the destination buffer.
Commit	Line	Data
f6bcfd97 BP	1	%
	2	% automatically generated by HelpGen from
	3	% ../include/wx/strconv.h at 25/Mar/00 10:20:56
	4	%
	5
	6	\section{\class{wxMBConvFile}}\label{wxmbconvfile}
	7
	8	This class converts file names between filesystem multibyte encoding and
	9	Unicode. It has one predefined instance, {\bf wxConvFile}.
	10	Since some platforms (e.g. Win32) use Unicode in the filenames,
	11	and others (e.g. Unix) use multibyte encodings, this class should only
	12	be used directly if wxMBFILES is defined to 1. A convenience macro,
	13	wxFNCONV, is defined to wxConvFile.cWX2MB in this case. You could use it
	14	like this:
	15
	16	\begin{verbatim}
	17	wxChar *name = wxT("rawfile.doc");
	18	FILE *fil = fopen(wxFNCONV(name), "r");
	19	\end{verbatim}
	20
	21	(although it would be better to use wxFopen(name, wxT("r")) in this case.)
	22
	23	\wxheading{Derived from}
	24
	25	\helpref{wxMBConv}{wxmbconv}
	26
	27	\wxheading{Include files}
	28
	29	<wx/strconv.h>
	30
	31	\wxheading{See also}
	32
	33	\helpref{wxMBConv classes overview}{mbconvclasses}
	34
	35	\latexignore{\rtfignore{\wxheading{Members}}}
	36
	37
	38	\membersection{wxMBConvFile::MB2WC}\label{wxmbconvfilemb2wc}
	39
	40	\constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
	41
	42	Converts from multibyte filename encoding to Unicode. Returns the size of the destination buffer.
	43
	44	\membersection{wxMBConvFile::WC2MB}\label{wxmbconvfilewc2mb}
	45
	46	\constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
	47
	48	Converts from Unicode to multibyte filename encoding. Returns the size of the destination buffer.
	49