Please enable JavaScript to view this site.

QPR Knowledge Base 2023.1

  •      
  • Navigation: Developer's Guide > QPR API > The Object Model > QPR Metrics > SCApplication Commands

    GetUserId

    Scroll Prev Top Next More

    Revision history:

    Introduced in QPR 7.3.1

     

    Returns the user ID of the user defined in the function call.

     

    Synopsis:

     

    SCApplication.GetUserId(vsLoginName, out UserId)

     

    Parameters:

     

    vsLoginName: Login name of the user whose ID is sought for. String.

    UserId: Contains the returned user ID. Integer.

     

    Required Rights:

     

    None.

     

    Return Values:

     

    RV_APPLICATION_QUIT_CALLED

    RV_NOT_CONNECTED_TO_SERVER

    RV_NOT_AUTHENTICATED

    RV_SUCCESS

    RV_USER_NOT_FOUND

     

    Example Procedure:

     

    iRet = SCApplication.GetUserId("John Smith", UserId)