Функция LookupPrivilegeDisplayNameA (winbase.h)

Статья
08/27/2023

Функция LookupPrivilegeDisplayName извлекает отображаемое имя, представляющее указанные привилегии.

Синтаксис

BOOL LookupPrivilegeDisplayNameA(
  [in, optional]  LPCSTR  lpSystemName,
  [in]            LPCSTR  lpName,
  [out, optional] LPSTR   lpDisplayName,
  [in, out]       LPDWORD cchDisplayName,
  [out]           LPDWORD lpLanguageId
);

Параметры

[in, optional] lpSystemName

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

[in] lpName

Указатель на строку, завершающуюся null, которая указывает имя привилегии, как определено в Winnt.h. Например, этот параметр может указать константу, SE_REMOTE_SHUTDOWN_NAME или соответствующую ей строку SeRemoteShutdownPrivilege. Список значений см. в разделе Константы привилегий.

[out, optional] lpDisplayName

Указатель на буфер, получающий строку, завершающуюся значением NULL, которая указывает отображаемое имя привилегии. Например, если параметр lpName имеет значение SE_REMOTE_SHUTDOWN_NAME, отображаемое имя привилегии — "Принудительное завершение работы из удаленной системы".

[in, out] cchDisplayName

Указатель на переменную, указывающую размер буфера lpDisplayName в TCHAR. При возврате функции этот параметр содержит длину отображаемого имени привилегии, не включая завершающий символ NULL. Если буфер, на который указывает параметр lpDisplayName , слишком мал, эта переменная содержит требуемый размер.

[out] lpLanguageId

Указатель на переменную, которая получает идентификатор языка для возвращаемого отображаемого имени.

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

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

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

Требования


Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	winbase.h (включая Windows.h)
Библиотека	Advapi32.lib
DLL	Advapi32.dll

См. также раздел

Обзор контроль доступа

Базовые функции контроль доступа

LookupPrivilegeName

LookupPrivilegeValue