Share via


ISpSREngineSite::IsAlternate

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method determines whether one CFG rule is an alternate of the other. As it is not possible to retrieve alternates for CFG rules from different recognition contexts, this method is an easy way for engines to determine if two rules belong to the same context.

Syntax

HRESULT IsAlternate(
  SPRULEHANDLE hPriRule,
  SPRULEHANDLE hAltRule
);

Parameters

  • hPriRule
    [in] Handle to the primary rule.
  • hAltRule
    [in] Handle to the alternate rule.

Return Value

The following table shows the possible return values.

Value Description

S_OK

hAltRule is an alternate of the handle specified by hPriRule.

S_FALSE

hAltRule is not an alternate of the handle specified by hPriRule.

FAILED(hr)

Appropriate error message.

Requirements

Header sapiddk.h, sapiddk.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpSREngineSite
SAPI Interfaces