RemoteOrderDisplay.ControlClock Method

2/27/2008

Performs the clock command requested in clockFunction on the specified video unit(s).

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

Syntax

'Declaration
Public MustOverride Sub ControlClock ( _
    units As DeviceUnits, _
    clockFunction As ClockFunction, _
    clockId As Integer, _
    hours As Integer, _
    minutes As Integer, _
    seconds As Integer, _
    row As Integer, _
    column As Integer, _
    attribute As VideoAttributes, _
    mode As ClockMode _
)

public abstract void ControlClock (
    DeviceUnits units,
    ClockFunction clockFunction,
    int clockId,
    int hours,
    int minutes,
    int seconds,
    int row,
    int column,
    VideoAttributes attribute,
    ClockMode mode
)

public:
virtual void ControlClock (
    DeviceUnits units, 
    ClockFunction clockFunction, 
    int clockId, 
    int hours, 
    int minutes, 
    int seconds, 
    int row, 
    int column, 
    VideoAttributes attribute, 
    ClockMode mode
) abstract

public abstract void ControlClock (
    DeviceUnits units, 
    ClockFunction clockFunction, 
    int clockId, 
    int hours, 
    int minutes, 
    int seconds, 
    int row, 
    int column, 
    VideoAttributes attribute, 
    ClockMode mode
)

public abstract function ControlClock (
    units : DeviceUnits, 
    clockFunction : ClockFunction, 
    clockId : int, 
    hours : int, 
    minutes : int, 
    seconds : int, 
    row : int, 
    column : int, 
    attribute : VideoAttributes, 
    mode : ClockMode
)

Parameters

• units
  The units to operate on.

• clockFunction
  The requested clock function.

• clockId
  Clock identification number. The valid values can be from 1 - Clocks. When the clockFunction parameter is Pause, Resume, or Stop, then clockId can be ClockAll to specify all clocks started on the specified video unit(s).

• hours
  The initial hours for the clock display.

• minutes
  The initial minutes for the clock display.

• seconds
  The initial seconds for the clock display.

• row
  The clock's row.

• column
  The clock's start column.

• attribute
  The video attribute.

• mode
  The type of clock to display.

Remarks

The clock is displayed in the requested mode format at the location found in the row and column parameters.

The clock starts at the specified hours, minutes, and seconds time values and is updated every second until a Pause or Stop is requested for this clockId.

When a Pause, Resume, or Stop command is issued, the hours, minutes, seconds, row, column, attribute, and mode parameters are ignored. During a Pause command, the clock display updates are suspended. During a Resume command, the clock updates continue.

If a Pause, Resume, Stop or Move command is requested on an uninitialized clockId for any of the video units specified by the units parameter, an ExtendedErrorBadClock is returned. If a Resume command is requested without performing a Pause, this has no effect and no error is returned.

When a Move command is issued, the clock is moved to the new location found in the row and column parameters. The hours, minutes, seconds, attribute, and mode parameters are ignored for this command function.

Generally a video unit can support the number of clocks specified by the Clocks property. However, the Start command returns ExtendedErrorNoClocks if it exceeds the number of SystemClocks, even though the Clocks property may indicate the unit can support more clocks than allocated for that unit.

ControlClock may cause a PosControlException exception to be thrown with the following ErrorCode:

Value	Description
Busy	A Start command is requested but the specified clockId is being used. The ErrorUnits and ErrorString properties are updated.
Failure	An error occurred while communicating with one of the video units specified by units. The ErrorUnits and ErrorString properties are updated before return. (Can be returned only if AsyncMode is false.)
ExtendedErrorBadClock	A Pause, Resume, Start, or Move command was requested and the specified clockId has not been initialized by the Start command.
ExtendedErrorNoClocks	The Start command failed because the number of SystemClocks has been reached.

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

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace
Clocks
ErrorString
ErrorUnits