Função CredReadA (wincred.h)
A função CredRead lê uma credencial do conjunto de credenciais do usuário. O conjunto de credenciais usado é o 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. O 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.
Retornar valor
A função retorna TRUE em caso de êxito e FALSE em caso de falha. A função GetLastError pode ser chamada para obter um código status mais específico. Os seguintes códigos de status podem ser retornados:
- ERROR_NOT_FOUND
Nenhuma credencial existe com o TargetName 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 .
Comentários
Se o valor do membro Type da estrutura CREDENTIAL especificada pelo parâmetro Credential 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.
Observação
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 de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
Requisito | Valor |
---|---|
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 | wincred.h |
Biblioteca | Advapi32.lib |
DLL | Advapi32.dll |