wpSetRefreshRate
This method is **specific to version 2.1, or higher, of the OS/2 operating system**.
This instance method **sets the status window update rate for the power object when the automatic refresh option is enabled**.
Syntax
_wpSetRefreshRate(somSelf, ulRefreshRate)
Parameters
- somSelf (WPPower *) - input
- Pointer to the object on which the method is being invoked.
- Points to an object of class WPPower.
- ulRefreshRate (ULONG) - input
- Contains the refresh rate value in minutes.
- The range is 1-30.
Returns
- rc (BOOL) - returns
- Success indicator.
- TRUE: Successful completion.
- FALSE: Failure, refresh rate is out of range.
Example Code
Declaration:
#define INCL_WINWORKPLACE #include <os2.h> WPPower *somSelf; /* Pointer to the object on which the method is being invoked. */ ULONG ulRefreshRate; /* Contains the refresh rate value in minutes. */ BOOL rc; /* Success indicator. */ rc = _wpSetRefreshRate(somSelf, ulRefreshRate);