Share via

LineDisplayBase.ClearDescriptorsImpl Method

  • Article

2/27/2008

Called by the LineDisplayBase.ClearDescriptors method.

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

Syntax

'Declaration
Protected Overridable Sub ClearDescriptorsImpl

protected virtual void ClearDescriptorsImpl ()

protected:
virtual void ClearDescriptorsImpl ()

protected void ClearDescriptorsImpl ()

protected function ClearDescriptorsImpl ()

Remarks

Called by the LineDisplayBase.ClearDescriptors method. In the event that the line display device doesn’t support descriptors, a default “not implemented” version of ClearDescriptorsImpl is provided. If descriptors are supported, the service object must implement ClearDescriptorsImpl.

Before calling ClearDescriptorsImpl, the LineDisplayBase class ensures that the following is true:

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

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

If these validations are performed successfully, the base class calls ClearDescriptorsImpl. If either fails, the base class throws an exception.

ClearDescriptorsImpl should throw exceptions for all other error conditions.

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.ClearDescriptors Method
LineDisplay.CapDescriptors Property