ICredentialProviderCredential::ReportResult method
Applies to: desktop apps only
Translates a received error status code into the appropriate user-readable message.
Syntax
HRESULT ReportResult( [in] NTSTATUS ntsStatus, [in] NTSTATUS ntsSubstatus, [out] LPWSTR *ppszOptionalStatusText, [out] CREDENTIAL_PROVIDER_STATUS_ICON *pcpsiOptionalStatusIcon );
Parameters
- ntsStatus [in]
-
Type: NTSTATUS
The NTSTATUS value that reflects the return value of the Winlogon call to LsaLogonUser.
- ntsSubstatus [in]
-
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.
- ppszOptionalStatusText [out]
-
Type: LPWSTR*
When this method returns, contains a pointer to a buffer of optional status message text. May be NULL.
- pcpsiOptionalStatusIcon [out]
-
Type: CREDENTIAL_PROVIDER_STATUS_ICON*
When this method returns, contains a pointer to a CREDENTIAL_PROVIDER_STATUS_ICON. 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 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.
Requirements
|
Minimum supported client | Windows Vista |
|---|---|
|
Minimum supported server | Windows Server 2008 |
|
Header |
|
|
IDL |
|
Send comments about this topic to Microsoft
Build date: 3/7/2012
