Share via

LineDisplayBase.SetDescriptor Method

  • Article

2/27/2008

Sets the state of a descriptor.

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

Syntax

'Declaration
Public Overrides Sub SetDescriptor ( _
    descriptor As Integer, _
    attribute As DisplaySetDescriptor _
)

public override void SetDescriptor (
    int descriptor,
    DisplaySetDescriptor attribute
)

public:
virtual void SetDescriptor (
    int descriptor, 
    DisplaySetDescriptor attribute
) override

public void SetDescriptor (
    int descriptor, 
    DisplaySetDescriptor attribute
)

public override function SetDescriptor (
    descriptor : int, 
    attribute : DisplaySetDescriptor
)

Parameters

  • descriptor
    Indicates which descriptor to change. The value can range between zero and one less than the value of the DeviceDescriptors property.
  • attribute
    Indicates the attribute for the descriptor. Possible values are defined by the DisplaySetDescriptor enumeration.

Remarks

Sets the state of one of the descriptors, which are small indicators with a fixed label.

If the CapDescriptors property is set to false, SetDescriptor throws an Illegal exception.

The line display’s service object determines the mapping of descriptor to its descriptors.

The LineDisplayBase class ensures that the line display device has been opened, claimed, and enabled, and that the values of the parameters are valid. It then calls LineDisplayBase.SetDescriptorImpl.

SetDescriptor may throw a PosControlException with the following ErrorCodes:

Value

Meaning

Illegal

One of the following conditions has occurred:The line display device does not support descriptors—that is, the CapDescriptors property is set to false; The value specified for descriptor is either less than zero or greater than the value of the DeviceDescriptors; or The value specified for attribute wasn’t found in the DisplaySetDescriptor enumeration.

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

LineDisplayBase Class
LineDisplayBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplay.SetDescriptor Method
SetDescriptorImpl