Share via

LineDisplayBase.SetDescriptorImpl Method (POS for .NET v1.14 SDK Documentation)

  • Article

3/2/2014

Called by the LineDisplayBase.SetDescriptor method.

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

Syntax

'Declaration
Protected Overridable Sub SetDescriptorImpl ( _
    descriptor As Integer, _
    attribute As DisplaySetDescriptor _
)

protected virtual void SetDescriptorImpl (
    int descriptor,
    DisplaySetDescriptor attribute
)

protected:
virtual void SetDescriptorImpl (
    int descriptor, 
    DisplaySetDescriptor attribute
)

protected void SetDescriptorImpl (
    int descriptor, 
    DisplaySetDescriptor attribute
)

protected function SetDescriptorImpl (
    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

Called by the LineDisplayBase.SetDescriptor method. In the event that the line display device doesn’t support descriptors, a default “not implemented” version of SetDescriptorImpl is provided. If the line display device supports descriptors, the service object must implement SetDescriptorImpl. Before calling SetDescriptorImpl, the LineDisplayBase class ensures that the following is true:

  • The line display device has been opened, claimed, and enabled;

  • The device supports descriptors—that is, that the CapDescriptors property is set to true;

  • That descriptor contains a legal value—that is, it isn’t less than zero or greater than the value of the DeviceDescriptors property; and

  • The value specified for attribute is a valid DisplaySetDescriptor value.

If these validations are performed successfully, the base class calls SetDescriptorImpl. If any of them fail, the base class throws an 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.

See Also

Reference

LineDisplayBase Class
LineDisplayBase Members
Microsoft.PointOfService.BaseServiceObjects Namespace
LineDisplayBase.SetDescriptor Method
LineDisplay.CapDescriptors Property
DisplaySetDescriptor Enumeration