TextConversionGenerator.GetCandidatesAsync Method
Definition
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.
Overloads
| GetCandidatesAsync(String) |
Asynchronously gets a list of candidate words based on the provided phonetic characters. |
| GetCandidatesAsync(String, UInt32) |
Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters. |
GetCandidatesAsync(String)
Asynchronously gets a list of candidate words based on the provided phonetic characters.
public:
virtual IAsyncOperation<IVectorView<Platform::String ^> ^> ^ GetCandidatesAsync(Platform::String ^ input) = GetCandidatesAsync;/// [Windows.Foundation.Metadata.Overload("GetCandidatesAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetCandidatesAsync(winrt::hstring const& input);[Windows.Foundation.Metadata.Overload("GetCandidatesAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(string input);function getCandidatesAsync(input)Public Function GetCandidatesAsync (input As String) As IAsyncOperation(Of IReadOnlyList(Of String))Parameters
- input
-
String
Platform::String
winrt::hstring
The phonetic characters of the words to be returned.
Returns
An asynchronous operation to return an IVectorView of the list of candidate words.
- Attributes
See also
Applies to
GetCandidatesAsync(String, UInt32)
Asynchronously gets a list of candidate words, up to a maximum count, based on the provided phonetic characters.
public:
virtual IAsyncOperation<IVectorView<Platform::String ^> ^> ^ GetCandidatesAsync(Platform::String ^ input, unsigned int maxCandidates) = GetCandidatesAsync;/// [Windows.Foundation.Metadata.Overload("GetCandidatesWithMaxCountAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<winrt::hstring>> GetCandidatesAsync(winrt::hstring const& input, uint32_t const& maxCandidates);[Windows.Foundation.Metadata.Overload("GetCandidatesWithMaxCountAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<string>> GetCandidatesAsync(string input, uint maxCandidates);function getCandidatesAsync(input, maxCandidates)Public Function GetCandidatesAsync (input As String, maxCandidates As UInteger) As IAsyncOperation(Of IReadOnlyList(Of String))Parameters
- input
-
String
Platform::String
winrt::hstring
The phonetic characters of the words to be returned.
- maxCandidates
-
UInt32
unsigned int
uint32_t
The maximum number of candidate words to return.
Returns
An asynchronous operation to return an IVectorView of the list of candidate words.
- Attributes
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for