.\" -*- nroff -*-
.\" Generated file - DO NOT EDIT!
.TH WideCharToMultiByte 3w "Oct 2012" "Wine API" "Wine API"

.SH NAME
\fBWideCharToMultiByte\fR (KERNEL32.@)
.SH SYNOPSIS
INT WideCharToMultiByte
 (
  UINT    \fIpage\fR,
  DWORD   \fIflags\fR,
  LPCWSTR \fIsrc\fR,
  INT     \fIsrclen\fR,
  LPSTR   \fIdst\fR,
  INT     \fIdstlen\fR,
  LPCSTR  \fIdefchar\fR,
  BOOL*   \fIused\fR
 )

.SH DESCRIPTION
.PP
Convert a Unicode character string into a multibyte string. 

.SH PARAMS
\fIpage\fR \fB[In]\fR  Code \fIpage\fR character set to convert to.
.PP
\fIflags\fR \fB[In]\fR  Mapping Flags (\fBMB_\fR constants from \fB"winnls.h"\fR).
.PP
\fIsrc\fR \fB[In]\fR  Source string buffer.
.PP
\fIsrclen\fR \fB[In]\fR  Length of \fIsrc\fR (in WCHARs), or \fB-1\fR if \fIsrc\fR is \fBNUL\fR terminated.
.PP
\fIdst\fR \fB[Out]\fR  Destination buffer.
.PP
\fIdstlen\fR \fB[In]\fR  Length of \fIdst\fR (in bytes), or \fB0\fR to compute the required length.
.PP
\fIdefchar\fR \fB[In]\fR  Default character to use for conversion if no exact conversion can be made.
.PP
\fIused\fR \fB[Out]\fR  Set if default character was \fIused\fR in the conversion.
.PP

.SH RETURNS
.PP
\fBSuccess:\fR If \fIdstlen\fR > \fB0\fR, the number of characters written to \fIdst\fR. If \fIdstlen\fR == \fB0\fR, number of characters needed to perform the conversion. In both cases the count includes the terminating \fBNUL\fR. 
.PP
\fBFailure:\fR \fB0.\fR Use \fBGetLastError(3w)\fR to determine the cause. Possible errors are \fBERROR_INSUFFICIENT_BUFFER\fR, if not enough space is available in \fIdst\fR and \fIdstlen\fR != \fB0\fR, and \fBERROR_INVALID_PARAMETER\fR, if an invalid parameter was given. 

.SH IMPLEMENTATION
.PP
Declared in \fB"winnls.h"\fR. 
.PP
Implemented in \fB"dlls/kernel32/locale.c"\fR. 
.PP
Debug channel \fB"nls"\fR.