Função CredReadA (wincred.h)

Artigo
11/20/2024

A função CredRead lê uma credencial 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 CredReadA(
  [in]  LPCSTR       TargetName,
  [in]  DWORD        Type,
  [in]  DWORD        Flags,
  [out] PCREDENTIALA *Credential
);

Parâmetros

[in] TargetName

Ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome da credencial a ser lida.

[in] Type

Tipo da credencial a ser lida. Tipo deve ser um dos tipos definidos CRED_TYPE_*.

[in] Flags

Atualmente reservado e deve ser zero.

[out] Credential

Ponteiro para um único buffer de bloco alocado para retornar a credencial. 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 seguintes códigos de status podem ser retornados:

ERROR_NOT_FOUND
Nenhuma credencial existe com oTargetName especificado.
ERROR_NO_SUCH_LOGON_SESSION
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
Um sinalizador que não é válido foi especificado para o parâmetro Flags.

Observações

Se o valor do tipo membro da estrutura de DE CREDENCIAIS especificada pelo parâmetro de Credenciais for CRED_TYPE_DOMAIN_EXTENDED, um namespace deverá ser especificado no nome de destino. Essa função pode retornar apenas uma credencial do tipo especificado.

Nota

O cabeçalho wincred.h define CredRead 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 [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

Compartilhar via