Edit

Share via

ICredentialProvider::GetCredentialAt method (credentialprovider.h)

  • Article

Gets a specific credential.

Syntax

HRESULT GetCredentialAt(
  [in]  DWORD                         dwIndex,
  [out] ICredentialProviderCredential **ppcpc
);

Parameters

[in] dwIndex

Type: DWORD

The zero-based index of the credential within the set of credentials enumerated for this credential provider.

[out] ppcpc

Type: ICredentialProviderCredential**

The address of a pointer to a ICredentialProviderCredential instance representing the credential.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is required.

The number of available credentials is retrieved by ICredentialProvider::GetCredentialCount. This method is used by the Logon UI or Credential UI in conjunction with GetCredentialCount to enumerate the credentials.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header credentialprovider.h