Share via

PHAuthenticateUser (Windows Embedded CE 6.0)

  • Article

1/6/2010

This function checks if the user is authenticated or not. If not, it will show the challenge User Interface and report back to the caller. The function will invoke the IP Home Screen application window if it needs to challenge the authentication and needs the component to process the message request. IP Home Screen is a component of the sample, IP Phone Suite. The caller can cancel an existing request with PHCancelAuthenticationRequest.

Note

This API is asynchronous in nature.

Syntax

HRESULT  PHAuthenticateUser(
    PH_AUTHENTICATE_USER_PARAMETERS*  pParams
);

Parameters

  • pParams
    [in, out] A pointer to a PH_AUTHENTICATE_USER_PARAMETERS structure with the authentication information and response window and message requested in it. It will also return the current status of the authentication request.

Return Value

The function returns a variety of HRESULT values, depending on whether the call succeeded or failed. The following table shows additional possible return values.

Value Description

S_OK

Success.

E_FAIL

Failure.

ERROR_NOACCESS

It is possible that the function was unable to invoke IP Home Screen when it needed to challenge the authentication.

E_INVALIDARG

Invalid parameters.

Remarks

Note

This documentation applies to functionality implemented in sample code for PhCommon. For more information, see PhCommon Reference.

Requirements

Header settingsapi.hpp
Library PhCommon.dll
Windows Embedded CE Windows Embedded CE 6.0 and later

See Also

Reference

PhCommon Authentication APIs
PhCommon Reference

Concepts

IP Phone Suite