IPen.RequestMode [Property][Get/Set]

Get or Set how multiple samples will be calculated on the server.

Defined As

• [VBA] Integer RequestMode
• [Cicode] INT RequestMode
• [C++] RequestMode RequestMode

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the mode is out of range, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure.

Remarks

When the pen makes a request for data and samples need to be compacted, it will use this mode to determine how the compaction will occur.

Changing this mode will clear the data cache and issue a new request for data.

See Also

RequestMode [Enumeration]

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)

 Dim requestMode As Integer

		`Getting Property value

   requestMode = pen.RequestMode

	 `Setting mode to minimum

  pen.RequestMode = 1

End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)

	INT requestMode;

  // Getting current property value

 requestMode = _ObjectGetProperty(hPen, "RequestMode");

	// Setting mode to minimum

		_ObjectSetProperty(hPen, "RequestMode", 1);

END