CheckLogin

Top  Previous  Next

SOAP

CheckLogin( aHandle, aUserGroupName, aUserLogin, aLogoutIfFound,

              &Found, &aErrorMsg );

 

REST

/CheckLogin?Handle=<Value>&UserGroup=<Value>&UserLogin=<Value>&LogoutIfFound=<Value>

Returns: Found, ErrorMsg

 

Description: CheckLogin() Searches currently active logins for specified UserLogin.  Found returns true if login exists.  Optionally, LogoutIfFound will logout this user if it exists.

 

aHandle The value created in the call to Login().  

aUserGroupName The name of the group that the specified Login is a member of.

aUserLogin The account to login as.

LogoutIfFound logs out this user if found to be logged in. (requires that the current user is a group admin)

&Found returns true if the login if found, false if not.

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.