LineDisplayWindow.ReadCharacterAtCursorAsync Method

Reference

Definition

Namespace:: Windows.Devices.PointOfService

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Attempts to asynchronously read the currently displayed character at the current cursor position.

public:
 virtual IAsyncOperation<unsigned int> ^ ReadCharacterAtCursorAsync() = ReadCharacterAtCursorAsync;

/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<uint32_t> ReadCharacterAtCursorAsync();

[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<uint> ReadCharacterAtCursorAsync();

function readCharacterAtCursorAsync()

Public Function ReadCharacterAtCursorAsync () As IAsyncOperation(Of UInteger)

Returns

IAsyncOperation<UInt32>

Windows.Foundation.IAsyncOperation

IAsyncOperation<uint32_t>

Returns the code for the character at the current cursor position. Returns 0 if the method fails.

Attributes: RemoteAsyncAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

This method requires LineDisplayCapabilities.CanReadCharacterAtCursor to be True to be succesfully executed.

Applies to