Home › User Guides › Serial Port Sniffer ActiveX Control

Serial Port Sniffer ActiveX Control - OnTimeouts

The OnTimeouts event occurs when other application changes the timeouts parameters of the virtual serial port.  

OnTimeouts(
  LONG *ReadIntervalTimeout,  
  LONG *ReadTotalTimeoutMultiplier,  
  LONG *ReadTotalTimeoutConstant,  
  LONG *WriteTotalTimeoutMultiplier,  
  LONG *WriteTotalTimeoutConstant,  
  VARIANT_BOOL *ExecuteAction  
);


Parameters

  ReadIntervalTimeout
 

[out] Maximum time, in milliseconds, allowed to elapse between the arrival of two characters on the communications line.
 
ReadTotalTimeoutMultiplier
 

[out] Multiplier, in milliseconds, used to calculate the total time-out period for read operations. For each read operation, this value is multiplied by the requested number of bytes to be read.
 
ReadTotalTimeoutConstant
 

[out] Constant, in milliseconds, used to calculate the total time-out period for read operations. For each read operation, this value is added to the product of the ReadTotalTimeoutMultiplier member and the requested number of bytes.
 
WriteTotalTimeoutMultiplier
 

[out] Multiplier, in milliseconds, used to calculate the total time-out period for write operations. For each write operation, this value is multiplied by the number of bytes to be written.
 
WriteTotalTimeoutConstant
 

[out] Constant, in milliseconds, used to calculate the total time-out period for write operations. For each write operation, this value is added to the product of the WriteTotalTimeoutMultiplier member and the number of bytes to be written.

 
  ExecuteAction - This parameter can be any of the following values:
   
 
Value Meaning
TRUE ExecuteAction sets OnTimeouts value in real serial port according to ReadIntervalTimeout, ReadTotalTimeoutMultiplier, ReadTotalTimeoutConstant, WriteTotalTimeoutMultiplier, WriteTotalTimeoutConstant values
FALSE ExecuteAction setting is ignored and not applied to real serial port