LineDisplay LineDisplay LineDisplay Class

Definition

Represents a line display device.

public sealed class LineDisplay : ILineDisplay, IClosablepublic sealed class LineDisplay : ILineDisplay, IDisposablePublic NotInheritable Class LineDisplay Implements ILineDisplay, IDisposable
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.

Properties

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
Value
LineDisplayCapabilities LineDisplayCapabilities LineDisplayCapabilities

The capabilities of the line display.

Attributes

DeviceControlDescription DeviceControlDescription DeviceControlDescription

Gets the device control description of the line display.

public string DeviceControlDescription { get; }public string DeviceControlDescription { get; }Public ReadOnly Property DeviceControlDescription As string
Value
string string string

The control description of the line display.

Attributes

DeviceControlVersion DeviceControlVersion DeviceControlVersion

Gets the device control version number of the line display.

public string DeviceControlVersion { get; }public string DeviceControlVersion { get; }Public ReadOnly Property DeviceControlVersion As string
Value
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.

Attributes

DeviceId DeviceId DeviceId

Gets the DeviceInformation.Id of the line display.

public string DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string
Value
string string string

The DeviceInformation.Id of the line display.

Attributes

DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion

Gets the service version number of the line display.

public string DeviceServiceVersion { get; }public string DeviceServiceVersion { get; }Public ReadOnly Property DeviceServiceVersion As string
Value
string string string

The UnifiedPOS service version number, formatted as a string.

Attributes

PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription

Gets the physical device description.

public string PhysicalDeviceDescription { get; }public string PhysicalDeviceDescription { get; }Public ReadOnly Property PhysicalDeviceDescription As string
Value
string string string

The physical device description given by the UnifiedPOS specification.

Attributes

PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName

Gets the physical device name.

public string PhysicalDeviceName { get; }public string PhysicalDeviceName { get; }Public ReadOnly Property PhysicalDeviceName As string
Value
string string string

The physical device name given by the UnifiedPOS specification.

Attributes

Methods

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 )
Returns

When the method completes, it returns a ClaimedLineDisplay.

Attributes

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
Attributes

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
Attributes

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

Creates a LineDisplay object from the DeviceInformation.Id.

public static IAsyncOperation<LineDisplay> FromIdAsync(String deviceId)public static IAsyncOperation<LineDisplay> FromIdAsync(String deviceId)Public Static Function FromIdAsync(deviceId As String) As IAsyncOperation( Of LineDisplay )
Parameters
deviceId
System.String System.String System.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.
Attributes

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 )
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.
Attributes

GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()

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

public static string GetDeviceSelector()public static string GetDeviceSelector()Public Static Function GetDeviceSelector() As string
Returns
string string string

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

Attributes

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 string GetDeviceSelector(PosConnectionTypes connectionTypes)public static string GetDeviceSelector(PosConnectionTypes connectionTypes)Public Static Function GetDeviceSelector(connectionTypes As PosConnectionTypes) As string
Parameters
connectionTypes
PosConnectionTypes PosConnectionTypes PosConnectionTypes

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

Returns
string string string

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

Attributes