IASPowerListBoxIntSpinner::get_Circular

This method retrieves whether or not the control wraps when it reaches the end of the list of integers.

Syntax

HRESULT get_Circular( BOOL *pfCircular );

Parameters

pfCircular

Pointer to a Boolean that is set to TRUE to enable wrapping, or to FALSE to disable it.

Return Values

NOERROR indicates success. E_OUTOFMEMORY indicates that the system is out of memory.

Remarks

If this property is enabled, the integer spinner control wraps from the last integer to the first or vice versa, depending on which direction the user is going.

Circular is defined as follows: If a user attempts to set the spinner control to a value greater than the maximum, the value is reset to the minimum. If a user attempts to set the spinner control to a value smaller than minimum, the value is reset to the maximum.