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

Статья
11/20/2024

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

Синтаксис

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. Если lpszRoleNULL, возвращаемое значение представляет длину строки, не включая символ NULL.

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

Замечания

Заметка

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

Требования

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

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