Função GetFileSecurityA (winbase.h)

Artigo
08/27/2023

A função GetFileSecurity obtém informações especificadas sobre a segurança de um arquivo ou diretório. As informações obtidas são restritas pelos direitos e privilégios de acesso do chamador.

A função GetNamedSecurityInfo fornece funcionalidade semelhante a GetFileSecurity para arquivos, bem como outros tipos de objetos.

Sintaxe

BOOL GetFileSecurityA(
  [in]            LPCSTR               lpFileName,
  [in]            SECURITY_INFORMATION RequestedInformation,
  [out, optional] PSECURITY_DESCRIPTOR pSecurityDescriptor,
  [in]            DWORD                nLength,
  [out]           LPDWORD              lpnLengthNeeded
);

Parâmetros

[in] lpFileName

Um ponteiro para uma cadeia de caracteres terminada em nulo que especifica o arquivo ou diretório para o qual as informações de segurança são recuperadas.

[in] RequestedInformation

Um valor SECURITY_INFORMATION que identifica as informações de segurança que estão sendo solicitadas.

[out, optional] pSecurityDescriptor

Um ponteiro para um buffer que recebe uma cópia do descritor de segurança do objeto especificado pelo parâmetro lpFileName . O processo de chamada deve ter permissão para exibir os aspectos especificados do status de segurança do objeto. A estrutura SECURITY_DESCRIPTOR é retornada no formato de descritor de segurança auto-relativo .

[in] nLength

Especifica o tamanho, em bytes, do buffer apontado pelo parâmetro pSecurityDescriptor .

[out] lpnLengthNeeded

Um ponteiro para a variável que recebe o número de bytes necessários para armazenar o descritor de segurança completo. Se o número retornado de bytes for menor ou igual a nLength, todo o descritor de segurança será retornado no buffer de saída; caso contrário, nenhum descritor será retornado.

Valor retornado

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

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

Comentários

Para ler o proprietário, grupo ou DACL do descritor de segurança para o arquivo ou diretório especificado, a DACL para o arquivo ou diretório deve conceder acesso READ_CONTROL ao chamador ou o chamador deve ser o proprietário do arquivo ou diretório.

Para ler o SACL de um arquivo ou diretório, o privilégio SE_SECURITY_NAME deve ser habilitado para o processo de chamada.

Requisitos


Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winbase.h (inclua Windows.h)
Biblioteca	Advapi32.lib
DLL	Advapi32.dll