RemoteOrderDisplay.ControlCursor Method

Enables or disables the cursor for the specified video unit(s).

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

Usage

'Usage
Dim units As DeviceUnits
Dim cursorType As VideoCursorType
Dim remoteOrderDisplay1 As RemoteOrderDisplay
remoteOrderDisplay1.ControlCursor(units, cursorType)

Syntax

'Declaration
Public MustOverride Sub ControlCursor( _
    ByVal units As DeviceUnits, _
    ByVal cursorType As VideoCursorType _
)

public abstract void ControlCursor(
    DeviceUnits units,
    VideoCursorType cursorType
);

public: abstract Void ControlCursor(
    DeviceUnits^ units,
    VideoCursorType^ cursorType
);

public abstract void ControlCursor(
    DeviceUnits units,
    VideoCursorType cursorType
);

public abstract function ControlCursor(
     units : DeviceUnits,
     cursorType : VideoCursorType
) : Void;

Parameters

• units
  The units to operate on.

• cursorType
  The type of cursor to display.

Remarks

When the cursorType is Off, the cursor is disabled; otherwise, the cursor is enabled as the requested cursor type.

If the video unit cannot support the requested cursor type, the service object uses the next closest cursor type.

The cursorType attribute is taken from the current cursor location.

ControlCursor returns void if successful, and can throw the following exception:

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.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

See Also

Reference

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace
ErrorString
ErrorUnits