Функция GetStringScripts (winnls.h)

Предоставляет список скриптов, используемых в указанной строке Юникода.

Синтаксис

int GetStringScripts(
  [in]            DWORD   dwFlags,
  [in]            LPCWSTR lpString,
  [in]            int     cchString,
  [out, optional] LPWSTR  lpScripts,
  [in]            int     cchScripts
);

Параметры

[in] dwFlags

Флаги, указывающие параметры для извлечения скрипта.

[in] lpString

Указатель на анализируемую строку Юникода.

[in] cchString

Размер (в символах) строки Юникода, указанной lpString. Приложение задает этому параметру значение -1, если строка Юникода завершается null. Если приложение задает этому параметру значение 0, функция получает пустую строку Юникода (L"\0") в lpScripts и возвращает значение 1.

[out, optional] lpScripts

Указатель на буфер, в котором эта функция извлекает строку со значением NULL, представляющую список скриптов, используя 4-символьную нотацию, используемую в СТАНДАРТЕ ISO 15924. Каждое имя скрипта состоит из четырех латинских символов, и имена извлекаются в алфавитном порядке. За каждым именем, включая последнее, следует точка с запятой.

Кроме того, этот параметр содержит значение NULL , если cchScripts имеет значение 0. В этом случае функция возвращает необходимый размер для буфера скрипта.

[in] cchScripts

Размер буфера скрипта в символах, указанный lpScripts.

Кроме того, приложение может задать для этого параметра значение 0. В этом случае функция получает значение NULL в lpScripts и возвращает необходимый размер для буфера скрипта.

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

Возвращает число символов, извлеченных в выходном буфере, включая завершающий символ NULL, если успешно и cchScripts имеет ненулевое значение. Функция возвращает значение 1, чтобы указать, что скрипт не найден, например, если входная строка содержит только символы COMMON или INHERITED, а GSS_ALLOW_INHERITED_COMMON не задан. Учитывая, что каждый найденный скрипт добавляет пять символов (четыре символа + разделитель), простая математическая операция предоставляет число скриптов как (return_code – 1) / 5.

Если функция выполняется успешно и значение cchScripts равно 0, функция возвращает необходимый размер в символах, включая завершающий символ NULL, для буфера скрипта. Число скриптов, как описано выше.

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

• ERROR_BADDB. Функции не удалось получить доступ к данным. Обычно такая ситуация не должна возникать и обычно указывает на неправильная установка, проблемы с диском или т. е.
• ERROR_INSUFFICIENT_BUFFER. Указанный размер буфера был недостаточно велик или для него неправильно задано значение NULL.
• ERROR_INVALID_FLAGS. Значения, указанные для флагов, были недопустимыми.
• ERROR_INVALID_PARAMETER. Любое из значений параметров было недопустимым.

Комментарии

Эта функция полезна в рамках стратегии по устранению проблем безопасности, связанных с международными доменными именами (IDN).

Определение скрипта основано на значениях скриптов, опубликованных консорциумом Юникода в http://www.unicode.org/Public/4.1.0/ucd/Scripts.txt, за исключением того, что неназначенные символы имеют значение "Zzzz" (UNASSIGNED) вместо "Zyyyy" (COMMON).

Ниже приведены некоторые примеры поведения этой функции:

Требования

См. также

DownlevelGetStringScripts

Обработка международных доменных имен (IDN)

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

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

VerifyScripts