ICredentialProvider::GetFieldDescriptorAt method

Gets metadata that describes a specified field.

Syntax

HRESULT GetFieldDescriptorAt(
  DWORD                                dwIndex,
  CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR **ppcpfd
);

Parameters

dwIndex

Type: DWORD

The zero-based index of the field for which the information should be retrieved.

ppcpfd

Type: CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR**

The address of a pointer to a CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR structure which receives the information about the field.

Return Value

Type: HRESULT

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

Remarks

This method is required.

Requirements

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