Expand Minimize

CredRead function

The CredRead function reads a credential from the user's credential set. The credential set used is the one associated with the logon session of the current token. The token must not have the user's SID disabled.

Syntax


BOOL CredRead(
  _In_   LPCTSTR TargetName,
  _In_   DWORD Type,
  _In_   DWORD Flags,
  _Out_  PCREDENTIAL *Credential
);

Parameters

TargetName [in]

Pointer to a null-terminated string that contains the name of the credential to read.

Type [in]

Type of the credential to read. Type must be one of the CRED_TYPE_* defined types.

Flags [in]

Currently reserved and must be zero.

Credential [out]

Pointer to a single allocated block buffer to return the credential. Any pointers contained within the buffer are pointers to locations within this single allocated block. The single returned buffer must be freed by calling CredFree.

Return value

The function returns TRUE on success and FALSE on failure. The GetLastError function can be called to get a more specific status code. The following status codes can be returned:

  • ERROR_NOT_FOUND

    No credential exists with the specified TargetName.

  • ERROR_NO_SUCH_LOGON_SESSION

    The logon session does not exist or there is no credential set associated with this logon session. Network logon sessions do not have an associated credential set.

  • ERROR_INVALID_FLAGS

    A flag that is not valid was specified for the Flags parameter.

Remarks

If the value of the Type member of the CREDENTIAL structure specified by the Credential parameter is CRED_TYPE_DOMAIN_EXTENDED, a namespace must be specified in the target name. This function can return only one credential of the specified type.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

WinCred.h

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

CredReadW (Unicode) and CredReadA (ANSI)

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.