Função CredEnumerateA (wincred.h)

Artigo
11/20/2024

A função CredEnumerate enumera as credenciais do conjunto de credenciais do usuário. O conjunto de credenciais usado é aquele associado à sessão de logon do token atual. O token não deve ter o SID do usuário desabilitado.

Sintaxe

BOOL CredEnumerateA(
  [in]  LPCSTR       Filter,
  [in]  DWORD        Flags,
  [out] DWORD        *Count,
  [out] PCREDENTIALA **Credential
);

Parâmetros

[in] Filter

Ponteiro para um cadeia de caracteresterminada nula que contém o filtro para as credenciais retornadas. Somente as credenciais com um TargetName correspondente ao filtro serão retornadas. O filtro especifica um prefixo de nome seguido por um asterisco. Por exemplo, o filtro "FRED*" retornará todas as credenciais com um TargetName começando com a cadeia de caracteres "FRED".

Se NULL for especificado, todas as credenciais serão retornadas.

[in] Flags

O valor desse parâmetro pode ser zero ou mais dos seguintes valores combinados com uma operação or debit a bit.

Valor	Significado
CRED_ENUMERATE_ALL_CREDENTIALS 0x1	Essa função enumera todas as credenciais no conjunto de credenciais do usuário. O nome de destino de cada credencial é retornado no formato "namespace:attribute=target". Se esse sinalizador estiver definido e o parâmetro filtro não estiver NULL, a função falhará e retornará ERROR_INVALID_FLAGS. Windows Server 2003 e Windows XP: Não há suporte para esse sinalizador.

[out] Count

Contagem das credenciais retornadas na matriz credenciais .

[out] Credential

Ponteiro para uma matriz de ponteiros para credenciais. A credencial retornada é um único bloco alocado. Todos os ponteiros contidos no buffer são ponteiros para locais dentro desse único bloco alocado. O único buffer retornado deve ser liberado chamando CredFree.

Valor de retorno

A função retorna TRUE com êxito e FALSE em caso de falha. A função GetLastError pode ser chamada para obter um código de status mais específico. Os códigos de status a seguir podem ser retornados.

Código/valor de retorno	Descrição
ERROR_NOT_FOUND 1168 (0x490)	Não existe nenhuma credencial que corresponda ao Filterespecificado.
ERROR_NO_SUCH_LOGON_SESSION 1312 (0x520)	A sessão de logon não existe ou não há nenhum conjunto de credenciais associado a esta sessão de logon. As sessões de logon de rede não têm um conjunto de credenciais associado.
ERROR_INVALID_FLAGS 1004 (0x3EC)	Um sinalizador que não é válido foi especificado para o parâmetro Flags ou CRED_ENUMERATE_ALL_CREDENTIALS é especificado para o parâmetro Flags e o parâmetro Filter não é NULL.

Observações

Nota

O cabeçalho wincred.h define CredEnumerate como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de 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 [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	wincred.h
biblioteca	Advapi32.lib
de DLL	Advapi32.dll

Consulte também

CredFree

GetLastError

Compartilhar via