HrJSOpen

The HrJSOpen function specifies a jump window's calculations and dimensions.

Quick Info

HRESULT HrJSOpen(
  JSWINDOWTYPE enType,    
  FILETIME * pftNow,      
  FILETIME * pftResolution,  
  DWORD dwWindowDuration,  
  HJSWINDOW * phJSWindow  
);
 

Parameters

enType

Input parameter. The type of calculation performed by the jump window:

JSWINDOW_MIN

The minimum value for period.

JSWINDOW_MAX

The maximum value for period.

JSWINDOW_AVERAGE

The average value for period.

JSWINDOW_TOTAL_RATE

The total of all values in period. This result can also be interpreted as a rate.

pftNow

Input parameter. Points to the current time, when the window starts operating.

pftResolution

Input parameter. Points to the time interval between window jumps.

dwWindowDuration

Input parameter. Width of the window, expressed as a multiple of ftResolution, the jump window resolution.

phJSWindow

Output parameter. Points to the handle to the jump window.

Return Values

See Return Values.

Remarks

HrJSOpen defines a jump window, including the type of calculation the jump window performs, its duration (the time span covered by the jump window), and its resolution (the time interval between window jumps).

The resolution is defined as a time interval, while the duration is defined as a multiple of the resolution. For example, if the window spans an hour and jumps every minute, the duration is 60.

For more information on this function, see Jump Window Functions in the Gateway Programmer's Reference.

See Also

HrFileTimeToSeconds, HrJSCollectDataPoint, HrJSGetValue, JSClose