ICredentialProviderCredential::ReportResult method (credentialprovider.h)

Article
10/13/2021

Translates a received error status code into the appropriate user-readable message. The Credential UI does not call this method.

Syntax

HRESULT ReportResult(
  [in]  NTSTATUS                        ntsStatus,
  [in]  NTSTATUS                        ntsSubstatus,
  [out] LPWSTR                          *ppszOptionalStatusText,
  [out] CREDENTIAL_PROVIDER_STATUS_ICON *pcpsiOptionalStatusIcon
);

Parameters

[in] ntsStatus

Type: NTSTATUS

The NTSTATUS value that reflects the return value of the Winlogon call to LsaLogonUser.

[in] ntsSubstatus

Type: NTSTATUS

The NTSTATUS value that reflects the value pointed to by the SubStatus parameter of LsaLogonUser when that function returns after being called by Winlogon.

[out] ppszOptionalStatusText

Type: LPWSTR*

A pointer to the error message that will be displayed to the user. May be NULL.

[out] pcpsiOptionalStatusIcon

Type: CREDENTIAL_PROVIDER_STATUS_ICON*

A pointer to an icon that will shown on the credential. May be NULL.

Return value

Type: HRESULT

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

Remarks

This method is required for Logon UI.

This method is used to report the outcome of a logon attempt back to a credential. The information in ntsStatus and ntsSubstatus can also be used when credential providers want to generate custom error messages. That status text from this call will be displayed on the selected credential.

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

Share via