Share via


PosPower.StandbyPos Method

2/27/2008

Requests that the POS system be put in the Standby state or responds to a request to put the system in the Standby state.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public Overridable Sub StandbyPos ( _
    reason As SystemStateChangeReason _
)
public virtual void StandbyPos (
    SystemStateChangeReason reason
)
public:
virtual void StandbyPos (
    SystemStateChangeReason reason
)
public void StandbyPos (
    SystemStateChangeReason reason
)
public function StandbyPos (
    reason : SystemStateChangeReason
)

Parameters

  • reason
    Specifies the reason StandbyPos has been called. Possible values are defined by the SystemStateChangeReason enumeration.

Remarks

The POS application calls StandbyPos to request that the POS system be put in the Standby state or to reply to a StatusUpdateEvent event of StatusStandby, allowing or denying the request. The application sets the reason parameter to the appropriate value, based on whether it is responding to an event or requesting the status change. Possible reasons, as defined by the SystemStateChangeReason enumeration, are as follows:

Member

Description

Allow

The request should be allowed.

Deny

The request should be denied.

Request

The system should enter the requested Standby or Suspend state.

If the Claimed property for the PosPower device is set to true and an application that does not have the device claimed calls StandbyPos, the service object throws a PosControlException exception.

If the CapStandbyPos property is false and the application tries to call StandbyPos, the service object throws an Illegal exception.

When the service object starts a change to Standby state, it sends a StatusUpdateEvent of StatusStandby to one or all applications, depending on whether the device is currently shareable.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

PosPower Class
PosPower Members
Microsoft.PointOfService Namespace