GetDefinedUserTypeVus Function

Action

Returns the maximum number of virtual users defined for the specified user type in the current workload, specified by script name, user group name, and profile name. The function returns 0 if the user type is disabled in the workload.

Include file

Kernel.bdh

Syntax

GetDefinedUserTypeVus(ScriptName    : in string,
                      UsergroupName : in string,
                      ProfileName   : in string) : number;

Return value

Maximum number of virtual users defined for the specified user type in the current workload

Parameter Description
ScriptName Script name as defined in the user type.
UsergroupName User group name as defined in the user type.
ProfileName Profile name as defined in the user type.

Example

dcltrans
  transaction TMain
  var
  begin
    Print(string(GetDefinedUserTypeVus("DefaultScript.bdf", "VUser", "Profile1"))); 
  end TMain;

Output

40