IProcessAnalyst.DataRequestRate [Property][Get/Set]

Indicates how often (in milliseconds) the Process Analyst Control will request data from the Trends Server(s). Internally the Process Analyst will choose the most optimum request rate for data, but this property can be used to slow the request down further.

Defined As

• [VBA] Integer DataRequestRate
• [Cicode] INT DataReqestRate
• [C++] short DataRequestRate

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad then the return value will be InvalidArgument.

Remarks

This property is useful for controlling the load on a Trends Server. The higher the figure the less load will be put on the Trends Server(s).

Limits

• Minimum = 10 milliseconds
• Maximum = 60000 milliseconds (1 minute)
• Default = 1000 milliseconds (1 second)

Calling Syntax

Assumes you have a page called "myPage" and the Process Analyst has been named "AN35".

[VBA]

Sub Example()

	Dim requestRate As Integer

		`Retrieve request rate

	requestRate = myPage_AN35.DataRequestRate

 `Set request rate

 myPage_AN35.DataRequestRate = 2000

End Sub

[Cicode]

FUNCTION Example()

 OBJECT hProcessAnalyst = ObjectByName("AN35");

	INT requestRate; 

 // Retrieve property value

		requestRate = _ObjectGetProperty(hProcessAnalyst, "DataRequestRate");

	 // Set property value to 2 seconds

		_ObjectSetProperty(hProcessAnalyst, "DataRequestRate", 2000);

END