LineDisplay.SetDescriptor Method

2/27/2008

Sets the state of a descriptor.

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

Syntax

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

public abstract void SetDescriptor (
    int descriptor,
    DisplaySetDescriptor attribute
)

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

public abstract void SetDescriptor (
    int descriptor, 
    DisplaySetDescriptor attribute
)

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

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.

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

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

The Line Display service object determines the mapping of descriptor to its descriptors.

SetDescriptor may cause a PosControlException to be thrown with the following ErrorCode.

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.
The value specified for attribute was not found in the DisplaySetDescriptor enumerator.

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