Função LookupPrivilegeDisplayNameA (winbase.h)

Artigo
11/20/2024

A função LookupPrivilegeDisplayName recupera o nome de exibição que representa um privilégio especificado.

Sintaxe

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

Parâmetros

[in, optional] lpSystemName

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do sistema no qual o nome do privilégio é recuperado. Se uma cadeia de caracteres nula for especificada, a função tentará localizar o nome de exibição no sistema local.

[in] lpName

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o nome do privilégio, conforme definido em Winnt.h. Por exemplo, esse parâmetro pode especificar a constante, SE_REMOTE_SHUTDOWN_NAME ou sua cadeia de caracteres correspondente, "SeRemoteShutdownPrivilege". Para obter uma lista de valores, consulte Privilege Constants.

[out, optional] lpDisplayName

Um ponteiro para um buffer que recebe uma cadeia de caracteres terminada em nulo que especifica o nome de exibição de privilégio. Por exemplo, se o parâmetro lpName for SE_REMOTE_SHUTDOWN_NAME, o nome de exibição de privilégio será "Forçar desligamento de um sistema remoto".

[in, out] cchDisplayName

Um ponteiro para uma variável que especifica o tamanho, em TCHAR s, do buffer lpDisplayName. Quando a função retorna, esse parâmetro contém o comprimento do nome de exibição de privilégio, não incluindo o caractere nulo de terminação. Se o buffer apontado pelo parâmetro lpDisplayName for muito pequeno, essa variável conterá o tamanho necessário.

[out] lpLanguageId

Um ponteiro para uma variável que recebe o identificador de idioma para o nome de exibição retornado.

Valor de retorno

Se a função for bem-sucedida, o valor retornado não será zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Observações

A função LookupPrivilegeDisplayName recupera nomes de exibição somente para os privilégios especificados na seção Privilégios Definidos de Winnt.h.

Nota

O cabeçalho winbase.h define LookupPrivilegeDisplayName como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	winbase.h (inclua Windows.h)
biblioteca	Advapi32.lib
de DLL	Advapi32.dll

Consulte também

Visão geral do controle de acesso

funções básicas de controle de acesso

LookupPrivilegeName

LookupPrivilegeValue

Compartilhar via