Функция GetStringTypeW (stringapiset.h)

Извлекает сведения о типах символов для символов в указанной исходной строке Юникода. Для каждого символа в строке функция задает один или несколько битов в соответствующем 16-разрядном элементе выходного массива. Каждый бит идентифицирует заданный тип символа, например букву, цифру или ни то, ни другой.

Синтаксис

BOOL GetStringTypeW(
  [in]  DWORD                         dwInfoType,
  [in]  _In_NLS_string_(cchSrc)LPCWCH lpSrcStr,
  [in]  int                           cchSrc,
  [out] LPWORD                        lpCharType
);

Параметры

[in] dwInfoType

Флаги, указывающие извлекаемую информацию о типе символов. Этот параметр может иметь следующие значения. Типы символов делятся на разные уровни, как описано в разделе Примечания.

[in] lpSrcStr

Указатель на строку Юникода, для которой извлекаются типы символов. Предполагается, что строка заканчивается нулевым значением, если для cchSrc задано какое-либо отрицательное значение.

[in] cchSrc

Размер (в символах) строки, указанной lpSrcStr. Если размер включает завершающий символ NULL, функция получает сведения о типе символа для этого символа. Если приложение задает для размера любое отрицательное целое число, предполагается, что исходная строка заканчивается null и функция автоматически вычисляет размер с дополнительным символом для завершения null.

[out] lpCharType

Указатель на массив 16-разрядных значений. Длина этого массива должна быть достаточно большой, чтобы получить одно 16-битовое значение для каждого символа в исходной строке. Если cchSrc не является отрицательным числом, lpCharType должен быть массивом слов с элементами cchSrc . Если для cchSrc задано отрицательное число, lpCharType — это массив слов с элементами lpSrcStr + 1. При возврате функции этот массив содержит одно слово, соответствующее каждому символу в исходной строке.

Возвращаемое значение

Возвращает ненулевое значение в случае успешного выполнения или значение 0 в противном случае. Чтобы получить расширенные сведения об ошибке, приложение может вызвать Метод GetLastError, который может возвращать один из следующих кодов ошибок:

• ERROR_INVALID_FLAGS. Значения, предоставленные для флагов, были недопустимыми.
• ERROR_INVALID_PARAMETER. Любое из значений параметров было недопустимым.

Комментарии

Общие сведения об использовании строковых функций см. в разделе Строки.

Значения параметров lpSrcStr и lpCharType не должны совпадать. Если они совпадают, функция завершается сбоем с ERROR_INVALID_PARAMETER.

Параметр Locale, используемый соответствующей функцией GetStringTypeA , не используется этой функцией. Из-за разницы параметров приложение не может автоматически вызывать правильную версию ANSI или Юникод функции GetStringType* , используя параметр #DEFINE ЮНИКОД. Приложение может обойти это ограничение с помощью рекомендуемой функции GetStringTypeEx.

Поддерживаемые типы символов

Биты символьного типа делятся на несколько уровней. Сведения для одного уровня могут быть получены одним вызовом этой функции. Каждый уровень ограничен 16 битами информации, поэтому другие функции сопоставления, которые ограничены 16 битами представления на символ, также могут возвращать сведения о типе символов.

Тип C 1

Эти типы поддерживают функции ввода символов ANSI C и POSIX (LC_CTYPE). Битовая или из этих значений извлекается в массиве в выходном буфере, если параметру dwInfoType присвоено значение CT_CTYPE1. Для языковых стандартов DBCS атрибуты типа применяются как к узким, так и к расширенным символам. Символы японской хираганы и катаканы, а также символы иеографа кандзи имеют атрибут C1_ALPHA.

Следующие типы символов являются постоянными или вычисляемыми из базовых типов и не должны поддерживаться этой функцией.

Тип Ctype 2

Эти типы поддерживают правильную разметку текста Юникода. Для языковых стандартов DBCS тип символа применяется как к узким, так и к расширенным символам. Атрибуты направления назначаются таким образом, чтобы алгоритм двунаправленного макета, стандартизированный в Юникоде, предоставлял точные результаты. Эти типы являются взаимоисключающими. Дополнительные сведения об использовании этих атрибутов см. в разделе Стандарт Юникода.

Ctype 3

Эти типы предназначены для заполнителей для расширений типов POSIX, необходимых для общей обработки текста или для стандартных функций библиотеки C. Побитовое ИЛИ этих значений извлекается, если параметру dwInfoType присвоено значение CT_CTYPE3. Для языковых стандартов DBCS атрибуты Ctype 3 применяются как к узким, так и к расширенным символам. Японские символы хираганы и катаканы, а также символы иеографа кандзи имеют атрибут C3_ALPHA.

C3_HIGHSURROGATE и C3_LOWSURROGATE перечислены только для полноты и никогда не должны предоставляться этой функции. Они актуальны только для Юникода.

Начиная с Windows 8: GetStringTypeW объявляется в Stringapiset.h. До Windows 8 он был объявлен в Winnls.h.

Требования

См. также

GetStringTypeA

GetStringTypeEx

Поддержка национальных языков

Функции поддержки национальных языков