LineDisplay LineDisplay LineDisplay LineDisplay Class

Definition

Represents a line display device.

public : sealed class LineDisplay : ILineDisplay, IClosable
public sealed class LineDisplay : ILineDisplay, IDisposable
Public NotInheritable Class LineDisplay Implements ILineDisplay, IDisposable
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

This object is created when a GetDefaultAsync or FromIdAsync method completes.

See the line display sample for an example implementation.

Properties

Capabilities Capabilities Capabilities Capabilities

Gets the capabilities of the specified line display.

public : LineDisplayCapabilities Capabilities { get; }
public LineDisplayCapabilities Capabilities { get; }
Public ReadOnly Property Capabilities As LineDisplayCapabilities
var lineDisplayCapabilities = lineDisplay.capabilities;

DeviceControlDescription DeviceControlDescription DeviceControlDescription DeviceControlDescription

Gets the device control description of the line display.

public : Platform::String DeviceControlDescription { get; }
public string DeviceControlDescription { get; }
Public ReadOnly Property DeviceControlDescription As string
var string = lineDisplay.deviceControlDescription;
Value
Platform::String string string string

The control description of the line display.

DeviceControlVersion DeviceControlVersion DeviceControlVersion DeviceControlVersion

Gets the device control version number of the line display.

public : Platform::String DeviceControlVersion { get; }
public string DeviceControlVersion { get; }
Public ReadOnly Property DeviceControlVersion As string
var string = lineDisplay.deviceControlVersion;
Value
Platform::String string string string

The UnifiedPOS control version number of the line display, formatted as a string. Read-only string that describes the UnifiedPOS control version number formatted as a string.

DeviceId DeviceId DeviceId DeviceId

Gets the DeviceInformation.Id of the line display.

public : Platform::String DeviceId { get; }
public string DeviceId { get; }
Public ReadOnly Property DeviceId As string
var string = lineDisplay.deviceId;
Value
Platform::String string string string

The DeviceInformation.Id of the line display.

DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion

Gets the service version number of the line display.

public : Platform::String DeviceServiceVersion { get; }
public string DeviceServiceVersion { get; }
Public ReadOnly Property DeviceServiceVersion As string
var string = lineDisplay.deviceServiceVersion;
Value
Platform::String string string string

The UnifiedPOS service version number, formatted as a string.

PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription

Gets the physical device description.

public : Platform::String PhysicalDeviceDescription { get; }
public string PhysicalDeviceDescription { get; }
Public ReadOnly Property PhysicalDeviceDescription As string
var string = lineDisplay.physicalDeviceDescription;
Value
Platform::String string string string

The physical device description given by the UnifiedPOS specification.

PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName

Gets the physical device name.

public : Platform::String PhysicalDeviceName { get; }
public string PhysicalDeviceName { get; }
Public ReadOnly Property PhysicalDeviceName As string
var string = lineDisplay.physicalDeviceName;
Value
Platform::String string string string

The physical device name given by the UnifiedPOS specification.

StatisticsCategorySelector StatisticsCategorySelector StatisticsCategorySelector StatisticsCategorySelector

Gets the standard UnifiedPOS statistics category selector strings.

public : static LineDisplayStatisticsCategorySelector StatisticsCategorySelector { get; }
public static LineDisplayStatisticsCategorySelector StatisticsCategorySelector { get; }
Public Static ReadOnly Property StatisticsCategorySelector As LineDisplayStatisticsCategorySelector
var lineDisplayStatisticsCategorySelector = Windows.Devices.PointOfService.LineDisplay.statisticsCategorySelector;
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Methods

CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync()

Gets the current power status of the device.

public : IAsyncOperation<LineDisplayPowerStatus> CheckPowerStatusAsync()
public IAsyncOperation<LineDisplayPowerStatus> CheckPowerStatusAsync()
Public Function CheckPowerStatusAsync() As IAsyncOperation( Of LineDisplayPowerStatus )
Windows.Devices.PointOfService.LineDisplay.checkPowerStatusAsync().done( /* Your success and error handlers */ );
Returns
Additional features and requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

ClaimAsync() ClaimAsync() ClaimAsync() ClaimAsync()

Attempts to gain exclusive access to the line display.

public : IAsyncOperation<ClaimedLineDisplay> ClaimAsync()
public IAsyncOperation<ClaimedLineDisplay> ClaimAsync()
Public Function ClaimAsync() As IAsyncOperation( Of ClaimedLineDisplay )
Windows.Devices.PointOfService.LineDisplay.claimAsync().done( /* Your success and error handlers */ );
Returns

Close() Close() Close() Close()

Close the line display session, allowing it to be claimed by another client. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

public : void Close()
This member is not implemented in C#
This member is not implemented in VB.Net
lineDisplay.close();

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++
void Dispose()
Sub Dispose
void Dispose()

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Creates a LineDisplay object from the DeviceInformation.Id.

public : static IAsyncOperation<LineDisplay> FromIdAsync(Platform::String deviceId)
public static IAsyncOperation<LineDisplay> FromIdAsync(String deviceId)
Public Static Function FromIdAsync(deviceId As String) As IAsyncOperation( Of LineDisplay )
Windows.Devices.PointOfService.LineDisplay.fromIdAsync(deviceId).done( /* Your success and error handlers */ );
Parameters
deviceId
Platform::String String String String

The DeviceInformation.Id that identifies a specific line display, which can be retrieved from the DeviceId property.

Returns

The line display specified by the unique device identifier. Returns a null object in the following cases:

  • The specific device is not found.
  • Access denied to the existing device. The user can deny access to a device, which is not treated as an exception.

GetDefaultAsync() GetDefaultAsync() GetDefaultAsync() GetDefaultAsync()

Returns the first available line display.

public : static IAsyncOperation<LineDisplay> GetDefaultAsync()
public static IAsyncOperation<LineDisplay> GetDefaultAsync()
Public Static Function GetDefaultAsync() As IAsyncOperation( Of LineDisplay )
Windows.Devices.PointOfService.LineDisplay.getDefaultAsync().done( /* Your success and error handlers */ );
Returns

The first available line display. Returns a null object in the following cases:

  • A device is not found.
  • Access denied to the existing device. The user can deny access to a device, which is not treated as an exception.

GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()

Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays.

public : static Platform::String GetDeviceSelector()
public static string GetDeviceSelector()
Public Static Function GetDeviceSelector() As string
var string = Windows.Devices.PointOfService.LineDisplay.getDeviceSelector();
Returns
Platform::String string string string

An Advanced Query Syntax string that is used to enumerate available line displays.

GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes)

Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types

public : static Platform::String GetDeviceSelector(PosConnectionTypes connectionTypes)
public static string GetDeviceSelector(PosConnectionTypes connectionTypes)
Public Static Function GetDeviceSelector(connectionTypes As PosConnectionTypes) As string
var string = Windows.Devices.PointOfService.LineDisplay.getDeviceSelector(connectionTypes);
Parameters
connectionTypes
PosConnectionTypes PosConnectionTypes PosConnectionTypes PosConnectionTypes

A list of the connection types to check for available line displays.

Returns
Platform::String string string string

An AQS string that is used to enumerate the line displays available over the specified connection types