На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

WideCharToMultiByte



The WideCharToMultiByte function maps a wide-character string to a new character string. The new character string is not necessarily from a multibyte character set.

int WideCharToMultiByte(

UINT CodePage, // code page
DWORD dwFlags, // performance and mapping flags
LPCWSTR lpWideCharStr, // address of wide-character string
int cchWideChar, // number of characters in string
LPSTR lpMultiByteStr, // address of buffer for new string
int cchMultiByte, // size of buffer
LPCSTR lpDefaultChar, // address of default for unmappable characters
LPBOOL lpUsedDefaultChar // address of flag set when default char. used
);


Parameters

CodePage

Specifies the code page used to perform the conversion. This parameter can be given the value of any codepage that is installed or available in the system. The following values may be used to specify one of the system default code pages:

Value Meaning
CP_ACP ANSI code page
CP_MACCP Macintosh code page
CP_OEMCP OEM code page


dwFlags

A set of bit flags that specify the handling of unmapped characters. The function performs more quickly when none of these flags is set. The following flag constants are defined:

Value Meaning
WC_COMPOSITECHECK Convert composite characters to precomposed characters.
WC_DISCARDNS Discard nonspacing characters during conversion.
WC_SEPCHARS Generate separate characters during conversion. This is the default conversion behavior.
WC_DEFAULTCHAR Replace exceptions with the default character during conversion.


When WC_COMPOSITECHECK is specified, the function converts composite characters to precomposed characters. A composite character consists of a base character and a nonspacing character, each having different character values. A precomposed character has a single character value for a base/nonspacing character combination. In the character и, the e is the base character, and the accent grave mark is the nonspacing character.

When an application specifies WC_COMPOSITECHECK, it can use the last 3 flags in this list (WC_DISCARDNS, WC_SEPCHARS, and WC_DEFAULTCHAR) to customize the conversion to precomposed characters. These flags determine the function's behavior when there is no precomposed mapping for a base/nonspace character combination in a wide-character string. These last 3 flags can only be used if the WC_COMPOSITECHECK flag is set.
The function's default behavior is to generate separate characters (WC_SEPCHARS) for unmapped composite characters.

lpWideCharStr

Points to the wide-character string to be converted.

cchWideChar

Specifies the number of characters in the string pointed to by the lpWideCharStr parameter. If this value is -1, the string is assumed to be null-terminated and the length is calculated automatically.

lpMultiByteStr

Points to the buffer to receive the translated string.

cchMultiByte

Specifies the size in characters of the buffer pointed to by the lpMultiByteStr parameter. If this value is zero, the function returns the number of bytes required for the buffer. (In this case, the lpMultiByteStr buffer is not used.)

lpDefaultChar

Points to the character used if a wide character cannot be represented in the specified code page. If this parameter is NULL, a system default value is used. The function is faster when both lpDefaultChar and lpUsedDefaultChar are NULL.

lpUsedDefaultChar

Points to a flag that indicates whether a default character was used. The flag is set to TRUE if one or more wide characters in the source string cannot be represented in the specified code page. Otherwise, the flag is set to FALSE. This parameter may be NULL. The function is faster when both lpDefaultChar and lpUsedDefaultChar are NULL.



Return Values

If the function succeeds, and cchMultiByte is nonzero, the return value is the number of bytes written to the buffer pointed to by lpMultiByteStr.
If the function succeeds, and cchMultiByte is zero, the return value is the required size, in bytes, for a buffer that can receive the translated string.
If the function fails, the return value is zero. To get extended error information, call GetLastError. GetLastError may return one of the following error codes:

ERROR_INSUFFICIENT_BUFFER
ERROR_INVALID_FLAGS
ERROR_INVALID_PARAMETER

Remarks

The lpMultiByteStr and lpWideCharStr pointers must not be the same. If they are the same, the function fails, and GetLastError returns ERROR_INVALID_PARAMETER.
An application can use the lpDefaultChar parameter to change the default character used for the conversion.
As noted earlier, the WideCharToMultiByte function operates most efficiently when both lpDefaultChar and lpUsedDefaultChar are NULL. The following table shows the behavior of WideCharToMultiByte for the four combinations of lpDefaultChar and lpUsedDefaultChar :

lpDefaultChar lpUsedDefaultChar Result
NULL NULL No default checking. This is the most efficient, quick way to use this function.
non-NULL NULL Uses the specified default character, but does not set lpUsedDefaultChar.
NULL non-NULL Uses the system default character and sets lpUsedDefaultChar if necessary.
non-NULL non-NULL Uses the specified default character and sets lpUsedDefaultChar if necessary.


See Also

MultiByteToWideChar


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

WideCharToMultiByte



Функция WideCharToMultiByte отображает широкую-символьную строку в новую символьную строку. Новая символьная строка - не обязательно из многобайтового набора символов.

int WideCharToMultiByte(

UINT CodePage, // КОДОВАЯ страница DWORD dwFlags, // исполнение и распределение флагов LPCWSTR lpWideCharStr, // адрес широкой-символьной строки int cchWideChar, // количество символов в строке LPSTR lpMultiByteStr, // адресе буфера для новой строки int cchMultiByte, // размер буфера LPCSTR lpDefaultChar, // адреса встроенной для адреса unmappable символов LPBOOL lpUsedDefaultChar // флага установленного когда невыполнение char. использовалось
);


Параметры

CodePage

Определяет кодовую страницу использованную, чтобы выполнять преобразование. Этот параметр может быть дан величина любого codepage, который установлен или доступный в системе. Следующее величин может быть использовано, чтобы определять одну из системных встроенных кодовых страниц:

Оцените Значение CP_ACP ANSI кодовой страничной CP_MACCP Macintosh кодовой страничной кодовой страницы CP_OEMCP OEM


dwFlags

Набор бита сигнализирует, что определяет обработку unmapped символов. Функция выполняет более быстро когда ни один из этих флагов не установлены. Константы флага следующего определены:

Значение Величины
составные символы Преобразования WC_COMPOSITECHECK на precomposed символы.
WC_DISCARDNS Отвергает nonspacing символов в течение преобразования.
WC_SEPCHARS Генерирует отдельные символы в течение преобразования. Это - встроенное конверсионное поведение.
WC_DEFAULTCHAR Заменяет исключения встроенным символом в течение преобразования.


Когда WC_COMPOSITECHECK определен, функция преобразовывает составные символы на precomposed символы. Составной символ состоит из базового символа и nonspacing символ, каждый иметь другие символьные величины. precomposed Символ имеет единственную символьную величину для базы/nonspacing символьной комбинации. В символе и, e - базовый символ, и серьезная отметка акцента является nonspacing символом.

Когда приложение определяет WC_COMPOSITECHECK, оно может использовать последние 3 флага в этом списке (WC_DISCARDNS, WC_SEPCHARS, и WC_DEFAULTCHAR), чтобы модифицировать по заказу пользователя преобразование на precomposed символы. Эти флаги определяют функциональное поведение когда нет precomposed распределения для базы/nonspace символьная комбинация в широкой-символьной строке. Эти последний раз 3 флага могут только использованы если флаг WC_COMPOSITECHECK установлен.
Функциональное встроенное поведение должно сгенерировать отдельные символы (WC_SEPCHARS) для unmapped составных символов.

lpWideCharStr

Точки на широкую-символьную строку, чтобы быть преобразованн.

cchWideChar

Определяет количество символов в строке указанной, чтобы параметром lpWideCharStr. Если эта величина - -1, строка принята, чтобы быть недействительный расторгнутым и длина вычисляется автоматически.

lpMultiByteStr

Точки на буфер, чтобы получать переведенную строку.

cchMultiByte

Определяет размер в типах буфера указанных, чтобы параметром lpMultiByteStr. Если эта величина является нулем, функция возвращает количество байтов необходимое для буфера. (В этом случае, буфер lpMultiByteStr - не used.)

lpDefaultChar

Точки на символ использовались если широкий символ не может быть представлен на определенной кодовой странице. Если этот параметр НЕДЕЙСТВИТЕЛЕН, системное значение по умолчанию использовано. Функция более быстрая когда как lpDefaultChar так и lpUsedDefaultChar НЕДЕЙСТВИТЕЛЬНЫ.

lpUsedDefaultChar

Точки на флаг, которые указывают был использован встроенный символ. Флаг установлен в ИСТИНУ если один или более широких символов в исходной строке не мочь быть представлено на определенной кодовой странице. В противном случае, флаг установлен в ЛОЖЬ. Этот параметр может быть НЕДЕЙСТВИТЕЛЕН. Функция более быстрая когда как lpDefaultChar так и lpUsedDefaultChar НЕДЕЙСТВИТЕЛЬНЫ.



Обратные Величины

Если функция получает, и cchMultiByte ненулевой, обратная величина является количеством байтов написанных в буфер указанный, чтобы lpMultiByteStr.
Если функция получает, и cchMultiByte - нуль, обратная величина является необходимым размером, в байтах, для буфера, который может получить переведенную строку.
Если функция терпит неудачу, обратная величина нулевая. Для того, чтобы расширять информацию ошибки, назовите GetLastError. GetLastError МОЖЕТ возвращать один из следующих кодов ошибки:

ERROR_INSUFFICIENT_BUFFER ERROR_INVALID_FLAGS ERROR_INVALID_PARAMETER

Замечания

lpMultiByteStr И указатели lpWideCharStr не должны быть теми же. Если они - те же, функция терпит неудачу, и возврат GetLastError ERROR_INVALID_PARAMETER.
Приложение может использовать параметр lpDefaultChar, чтобы изменять по умолчанию символ использованный для преобразования.
Как отмечено раньше, функция WideCharToMultiByte обслуживает наиболее эффективно когда как lpDefaultChar так и lpUsedDefaultChar НЕДЕЙСТВИТЕЛЬНЫ. Следующая таблица показывает поведение WideCharToMultiByte для четырех комбинаций lpDefaultChar и lpUsedDefaultChar:

РЕЗУЛЬТАТ lpDefaultChar lpUsedDefaultChar
НЕДЕЙСТВИТЕЛЬНАЯ НЕДЕЙСТВИТЕЛЬНАЯ No по умолчанию проверка. Это - наиболее эффективный, быстрый путь использовать эту функцию.
НЕ-НЕДЕЙСТВИТЕЛЬНЫЙ НЕДЕЙСТВИТЕЛЬНЫЙ Использует определенный по умолчанию символ но не делает устанавливать lpUsedDefaultChar.
НЕДЕЙСТВИТЕЛЬНЫЙ не-НЕДЕЙСТВИТЕЛЬНЫЙ Использует системный по умолчанию символ и устанавливает lpUsedDefaultChar если необходимо.
НЕ-НЕДЕЙСТВИТЕЛЬНЫЙ не-НЕДЕЙСТВИТЕЛЬНЫЙ Использует определенный по умолчанию символ и устанавливает lpUsedDefaultChar если необходимо.


Смотри Также

MultiByteToWideChar


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz