WebGetSpeed Function

Action

Gets the current value of the simulation speed as a number. A value of 0 represents maximum speed.

Include file

WebAPI.bdh

Syntax

WebGetSpeed(in nFlag : number optional, 
out bDuplex : boolean optional 
out fCompression : float optional): number;

Return value

current value of the simulation speed

Parameter Description
nFlag

Specifies whether to retrieve the simulation speed for sending or for receiving data (optional). This parameter can be one of the following values:

  • WEB_SPEED_SEND. Gets the simulation speed for sending data.

  • WEB_SPEED_RECV. Gets the simulation speed for receiving data (default).

bDuplex Variable that receives a boolean value which indicates whether the simulation speeds for sending and receiving data differ (optional).
fCompression Variable that receives the hardware compression rate of the simulated network device (optional).

Example

dcltrans 
  transaction TWebInit 
  begin 
    write("SimulationSpeed: "); 
    write(WebGetSpeed()); 
    writeln; 
  end TWebInit;