API functions

The API provides four functions to enable the use of SSO:

• LogonSSOUser
• LogonSSOUserWithPin
• LogoffSSOUser
• IsReconnectioninProgress

LogonSsoUser

LOGONSSOUSER_ERROR_CODE APIENTRY
LogonSsoUser (
   MSV1_0_INERACTIVE_LOGON  pNewCredentials,
   BOOL   notUsed,
   BOOL  notUsed2,
   DWORD  *pDwResult
  )
<!--NeedCopy-->

This function is used to provide user credentials to single sign-on (SSO). If this function is invoked from a service, the service can call these APIs in the locally logged-on user’s session.

LogonSsoUserWithPin

BOOL APIENTRY DoLogonSsoUserWithPin
 (
 const wchar_t* pin
 )
<!--NeedCopy-->

This function is used to provide smart card user credentials to SSO.

LogoffSSOUser

DWORD APIENTRY
LogoffSsoUser(
 DWORD  notUsed
  )
<!--NeedCopy-->

This function removes the credentials of the current SSO user and restores the previous user’s credentials if available.

IsReconnectInProgress

DWORD APIENTRY
IsReconnectInProgress
  (
 DWORD dwTimeout,
 LPBOOL lpReconnectInProgress
)
<!--NeedCopy-->

This function works with auto client reconnect to determine whether a reconnect is being attempted after the last logon using LogonSsoUser(). You must call it immediately after LogonSsoUser. If there is a session to reconnect, the auto client reconnect feature issues the reconnect request. The API communicates that a new reconnect request has been issued. Therefore no new session launch request is needed.

The function detects only whether a reconnect request has been attempted. It cannot detect whether the reconnect succeeded or failed.

For this function to operate successfully for the Web Interface, you must enable the XenApp Services site setting. Automatically reconnect to sessions when users log on.