ISpPhraseAlt::GetAltInfo
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets data elements associated with an alternate phrase.
Syntax
HRESULT GetAltInfo(
ISpPhrase** ppParent,
ULONG* pulStartElementInParent,
ULONG* pcElementsInParent,
ULONG* pcElementsInAlt
);
Parameters
- ppParent
[out] Address of a pointer to an object implementing ISpPhrase that represents the parent phrase.
- pulStartElementInParent
[out] Pointer to the starting element within the parent phrase to which the alternate applies.
- pcElementsInParent
[out] Pointer to the number of elements within the parent that the alternate replaces.
- pcElementsInAlt
[out] Pointer to the number of elements that the alternate contains.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_INVALIDARG |
At least one of the parameters is invalid or bad. |
SPERR_NOT_FOUND |
The alternate is not associated with a valid parent phrase object. |
Requirements
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |