GetVoiceRecResultsByMeaning

Metreos.Native.VoiceRecResults.GetVoiceRecResultsByMeaning

Summary

GetVoiceRecResultsByMeaning will extract results from the specified VoiceRecResultList based on the meaning substring and match condition.

Usage

The GetVoiceRecResultsByMeaning action will return a new VoiceRecResultList comprised of results that match the specified substring and match condition. The string condition is executed in a case-insensitive manner.

Remarks

If the specified VoiceRecResultList is null, if the ResultList property on the VoiceRecResultList is null, or if Meaning null or empty, then Failure is returned by the action.

Action Parameters
Parameter Name.NET TypeDefaultDescription
VoiceRecResultList *Metreos.Types.VoiceRec.VoiceRecResultListA VoiceRecResultList, initialized by the VR_XMLResult event parameter contained in the VoiceRecognition_Complete event, or returned by a previous GetVoiceRecResult, GetVoiceRecResultByScore, GetVoiceRecResultsByMeaning.
Meaning *System.StringThe string which will be used to compare against each result's meaning contained in the VoiceRecResultList.
Option *Metreos.Types.VoiceRec.OptionMatching options:
Matches

The use of Matches will only return results with a meaning exactly matching the specified Meaning, case-insensitive.

Contains

The use of Contains will only return results with a meaning containing the specified Meaning, case-insensitive.

Starts

The use of Starts will only return results with a meaning starting with the specified Meaning, case-insensitive.

Ends

The use of Ends will only return results with a meaning ending with the specified Meaning, case-insensitive.

Result Data
Parameter Name.NET TypeDescription
ResultListMetreos.Types.VoiceRec.VoiceRecResultListThe list of results that have a meaning matching the specified Meaning, using the specified match Option.

Branch Conditions 

Success

No description.

Failure

No description.