Please enable JavaScript to view this site.

QPR Knowledge Base 2023.1

  •      
  • Navigation: Developer's Guide > QPR API > The Object Model > QPR Modeling > PGApplication Commands

    GetUserInfo

    Scroll Prev Top Next More

    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:

     

    PGApplication.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 Modeling Client or Web Client users) with rights to QPR Modeling Client 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 = PGApplication.GetUserInfo(1234, UserInfoArray)