HandwritingView.GetCandidates(UInt32) Method

Reference

Definition

Namespace:: Windows.UI.Xaml.Controls

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

Retrieves the updated collection of auto-completion candidates after a CandidatesChanged event.

public:
 virtual IVectorView<Platform::String ^> ^ GetCandidates(unsigned int candidatesSessionId) = GetCandidates;

IVectorView<winrt::hstring> GetCandidates(uint32_t const& candidatesSessionId);

public IReadOnlyList<string> GetCandidates(uint candidatesSessionId);

function getCandidates(candidatesSessionId)

Public Function GetCandidates (candidatesSessionId As UInteger) As IReadOnlyList(Of String)

Parameters

candidatesSessionId: UInt32
unsigned int

uint32_t

CandidatesSessionId

Returns

IVectorView<String>

IReadOnlyList<String>

IVectorView<Platform::String>

IVectorView<winrt::hstring>

The updated collection of auto-completion candidates.

The candidate collection is returned only if the CandidatesSessionId is current.

Windows requirements

Device family	Windows 10, version 2104 (introduced in 10.0.20348.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v12.0)

Applies to