Edit

ITfLMLattice::EnumLatticeElements method (ctffunc.h)

  • Article

Obtains an enumerator that contains all lattice elements contained in the lattice property that start at or after a specific offset from the start of the frame.

Syntax

HRESULT EnumLatticeElements(
  [in]  DWORD                  dwFrameStart,
  [in]  REFGUID                rguidType,
  [out] IEnumTfLatticeElements **ppEnum
);

Parameters

[in] dwFrameStart

Specifies the offset, in 100-nanosecond units, relative to the start of the phrase, of the first element to obtain.

[in] rguidType

Specifies the lattice type identifier. This can be one of the Lattice Type values.

[out] ppEnum

Pointer to an IEnumTfLatticeElements interface pointer that receives the enumerator object.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_FAIL
 An unspecified error occurred.
E_INVALIDARG
 rguidType is unsupported by the lattice property.
E_OUTOFMEMORY
 A memory allocation failure occurred.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ctffunc.h
DLL Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

IEnumTfLatticeElements

ITfLMLattice

Lattice Types