Power Related Methods

A program or Workplace Shell object would call the following methods to get information about a power object. A power object would override these methods to define its characteristics.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryAutoRefresh            │Returns the current state     │
│                              │(enabled or disabled) for     │
│                              │automatic refresh of the power│
│                              │object's status window.       │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryRefreshRate            │Returns the current refresh   │
│                              │rate (in minutes) for the     │
│                              │power object's status window  │
│                              │when automatic refresh is     │
│                              │enabled.                      │
└──────────────────────────────┴──────────────────────────────┘

A program or Workplace Shell object would call the following methods to get information about a power object. These methods are normally not overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryDefStatusView          │Returns the default view for  │
│                              │the power object when         │
│                              │"Advanced power management"   │
│                              │(APM) is enabled.             │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryPowerConfirmation      │Returns the current state     │
│                              │(enabled or disabled) for the │
│                              │power object's confirmation   │
│                              │message. This message is      │
│                              │optionally displayed when     │
│                              │power state changes are       │
│                              │requested from its context    │
│                              │menu.                         │
├──────────────────────────────┼──────────────────────────────┤
│wpQueryPowerManagement        │Returns the current state     │
│                              │(enabled or disabled) for     │
│                              │"Advanced power management"   │
│                              │(APM).                        │
└──────────────────────────────┴──────────────────────────────┘

A program or Workplace Shell object would call the following methods to set information about a power object. These methods are normally not overridden.

┌──────────────────────────────┬──────────────────────────────┐
│Method Name                   │Description                   │
├──────────────────────────────┼──────────────────────────────┤
│wpSetAutoRefresh              │Enables or disables automatic │
│                              │refresh of the power object's │
│                              │status window.                │
├──────────────────────────────┼──────────────────────────────┤
│wpSetDefStatusView            │Sets the default status view  │
│                              │for the power object when     │
│                              │"Advanced power management" is│
│                              │enabled.                      │
├──────────────────────────────┼──────────────────────────────┤
│wpSetPowerConfirmation        │Enables or disables the       │
│                              │display of the power object's │
│                              │confirmation message when     │
│                              │power state changes are       │
│                              │requested from its context    │
│                              │menu.                         │
├──────────────────────────────┼──────────────────────────────┤
│wpSetPowerManagement          │Enables or disables "Advanced │
│                              │power management".            │
├──────────────────────────────┼──────────────────────────────┤
│wpSetRefreshRate              │Sets the refresh rate for the │
│                              │power object's status window  │
│                              │when automatic refresh is     │
│                              │enabled.                      │
└──────────────────────────────┴──────────────────────────────┘


[Back: Palette Related Methods]
[Next: Printer and Print Job Related Methods]