LogonIdentityEx
Authenticates an identity handle and requests service tickets for one or more sites in one request to the login service.
HRESULT LogonIdentityEx(
IN PassportIdentityHandle hIdentity,
IN OPTIONAL LPCWSTR wszAuthPolicy,
IN DWORD dwAuthFlags,
IN PCRSTParams pcRSTParams
IN DWORD dwRSTParamsCount
);
Parameters
hIdentity
The identity handle for which authentication is being requested.
wszAuthPolicy
Optional. Reserved for future use.
dwAuthFlags
A member of the LOGON_FLAG enumeration. Typically, this value should be LOGONIDENTITY_DEFAULT, to indicate that default authentication is to be used. There are other flags that are used for identity federation and linked identities. For more information, see LOGON_FLAG.
pcRSTParams
An array of RSTParams structures that contain parameters for the batched ticketing behavior and service targets. Includes information service names, and policies for the login service to use to issue service tickets.
dwRSTParamsCount
The number of requests in the array of RSTParams structures.
Return Value
The following table describes the return values for this method.
Return Code |
Description |
|---|---|
PPCRL_E_AUTH_SERVICE_UNAVAILABLE |
A connection with the Windows Live ID service could not be established. This error is returned only when offline authentication is disabled. |
PPCRL_E_INVALIDFLAGS |
Invalid sign-in flags. Flags must come from the LOGON_FLAG enumeration. |
PPCRL_E_NO_MEMBER_NAME_SET |
No sign-in name has been set for the identity. |
PPCRL_E_REALM_LOOKUP |
Cannot look up realm information for federated sign-in. |
PPCRL_NO_SESSION_KEY |
A session key could not be found. |
PPCRL_REQUEST_E_INVALID_MEMBER_NAME |
The identity sign-in name is not of format xxxx@yyyy. |
PPCRL_REQUEST_E_MISSING_PRIMARY_CREDENTIAL |
The password was not found for the identity. |
PPCRL_REQUEST_E_NO_NETWORK |
A network connection could not be established. This error is returned only when offline authentication is disabled. |
PPCRL_REQUEST_E_WRONG_DA |
The correct domain authority could not be found. |
PPCRL_REQUESTPARAMS_MISSING |
The authentication request could not be initialized or built. |
PPCRL_REQUEST_S_IO_PENDING |
In synchronous requests, a thread is waiting for a ticket from the server. |
S_OK |
The authentication call was completed successfully. |