QPR Knowledge Base 2012.1

GetUserInfo

GetUserInfo

Previous topic Next topic  

GetUserInfo

Previous topic Next topic  

Revision history:

Introduced in QPR 7.3.2 SP1

Last changed in QPR 7.4.1

 

Returns an array of user information about the user ID(s) defined in the function call.

 

Synopsis:

 

SCApplication.GetUserInfo(UserId, out UserInfoArray);

 

Parameters:

 

UserId: ID of the user whose user information is sought for. Integer. In the case this parameter is -1, all users (both QPR Metrics client or Web Client users) with rights to QPR Metrics are returned. In the case the value is the ID of a group, all users belonging to that group are returned.

UserInfoArray: Variant array for containing the array comprised of the returned user information. The array contains one row per user and four columns containing user information. The user information columns are as follows:

UserID - User's user ID. Integer.

LoginName - User's login name. String.

FullName - User's full name. String.

Email - User's e-mail address. String.

 

Required Rights:

 

None.

 

Return Values:

 

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_SUCCESS

RV_USER_NOT_FOUND

 

Example Procedure:

 

iRet = SCApplication.GetUserInfo(1234, UserInfoArray)