ISpRecoContext::GetMaxAlternates

  • Article

This method gets the maximum number of alternates that the SR engine will retrieve for command and control or proprietary grammars associated with the speech recognition context. See Remarks section.

This method has no effect on dictation alternates. See ISpRecoResult::GetAlternates for information regarding dictation alternates.

The current version of the Microsoft SR engine does not support command and control alternates.

HRESULT GetMaxAlternates(
  ULONG* pcMaxAlternates
);

Parameters

  • pcMaxAlternates
    [out] Pointer to the maximum number of alternates. The default value is zero, unless the application specifies it by ISpRecoContext::SetMaxAlternates.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_POINTER pcMaxAlternates is invalid or bad.
FAILED(hr) Appropriate error message.

Remarks

The value is the maximum number of alternates that the SR engine will retrieve for the application. For SR engines that do not support command and control (or proprietary grammar) alternates, this method will succeed, but the alternates retrieved will always be zero.

For applications and SR engines that are using proprietary grammars and proprietary alternates, this method and ISpRecoContext::SetMaxAlternates is the recommended method of coordinating maximum alternate values between the application and SR engine.

The SR engine can query each context's maximum requested alternates value by calling ISpSREngineSite::GetContextMaxAlternates with the context handle. When using SAPI command and control grammars, the SR engine can call ISpSREngineSite::GetMaxAlternates with the rule handle.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpRecoContext | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.