QPR Knowledge Base 2012.1

GetGroupInfo

GetGroupInfo

Previous topic Next topic  

GetGroupInfo

Previous topic Next topic  

Revision history:

Introduced in QPR 7.4.1

 

Returns an array of group information about the group ID defined in the function call.

 

Synopsis:

 

SCApplication.GetGroupInfo(GroupID, out UserGroupArray)

 

Parameters:

 

GroupID: Integer. ID of some group. In the case this parameter is -1, all groups (both QPR Metrics client or Web Client user groups) with rights to QPR Metrics are returned. In the case this parameter is the ID of some user, all groups the user belongs to are returned.

out UserGroupArray: Variant array. Variant array containing all returned groups. Every row has the following columns:

Group ID, Integer

Group name, String

 

Required Rights:

 

None.

 

Return Values:

Below are listed the return values that this function can return:

 

RV_APPLICATION_QUIT_CALLED

RV_NOT_CONNECTED_TO_SERVER

RV_NOT_AUTHENTICATED

RV_SUCCESS

RV_GROUP_NOT_FOUND

 

Example Procedure:

 

iRet = SCApplication.GetGroupInfo(1234, UserGroupArray)