Поделиться через

Функция GetRoleTextA (oleacc.h)

  • Статья

Извлекает локализованную строку, описывающую роль объекта для указанного значения роли.

Синтаксис

UINT GetRoleTextA(
  [in]  DWORD lRole,
  [out] LPSTR lpszRole,
  [in]  UINT  cchRoleMax
);

Параметры

[in] lRole

Тип: DWORD

Одна из констант роли объекта .

[out] lpszRole

Тип: LPTSTR

Адрес буфера, получающего текстовую строку роли. Если этот параметр имеет значение NULL, функция возвращает длину строки роли, не включая символ NULL.

[in] cchRoleMax

Тип: UINT

Размер буфера, на который указывает параметр lpszRole . Для строк ANSI это значение измеряется в байтах; для строк Юникода он измеряется в символах.

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

Тип: UINT

Если значение lpszRole не равно NULL, возвращается количество байтов (строки ANSI) или символов (строки Юникода), скопированных в буфер, не включая завершающий символ NULL. Если lpszRole имеет значение NULL, возвращаемое значение представляет длину строки, не включая символ NULL.

Если строковый ресурс не существует или параметр lpszRole не является допустимым указателем, возвращаемое значение равно нулю (0). Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Примечание

Заголовок oleacc.h определяет GetRoleText как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header oleacc.h
Библиотека Oleacc.lib
DLL Oleacc.dll
Распространяемые компоненты Активные специальные возможности 1.3 RDK в Windows NT 4.0 с пакетом обновления 6 (SP6) и более поздних версий и Windows 95