Translates a received error status code into the appropriate user-readable message.

Syntax

HRESULT ReportResult(      
    NTSTATUS ntsStatus,
    NTSTATUS ntsSubstatus,
    LPWSTR *ppszOptionalStatusText,
    CREDENTIAL_PROVIDER_STATUS_ICON *pcpsiOptionalStatusIcon
);

Parameters

ntsStatus

[in] The NTSTATUS reflecting the return value of the Winlogon call to LsaLogonUser.

ntsSubstatus

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

ppszOptionalStatusText

[out] When this method returns, contains a pointer to a buffer of optional status message text. May be NULL.

pcpsiOptionalStatusIcon

[out] When this method returns, contains a pointer to a CREDENTIAL_PROVIDER_STATUS_ICON. May be NULL.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

This method is required for logon user interface (UI) but optional for credential 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.