Edit

ITfFnPlayBack::QueryRange method (ctffunc.h)

  • Article

Obtains the range of text for a word or phrase that contains audio data.

Syntax

HRESULT QueryRange(
  [in]  ITfRange *pRange,
  [out] ITfRange **ppNewRange,
  [out] BOOL     *pfPlayable
);

Parameters

[in] pRange

Pointer to an ITfRange object that covers all or part of the text that contains audio data.

[out] ppNewRange

Pointer to an ITfRange pointer that receives a range object that covers all of the text that contains audio data. If there is no audio data for the text covered by pRange, this parameters receives NULL. In this case, the method returns S_OK, so the caller must verify that this parameter is not NULL before using the pointer.

[out] pfPlayable

Pointer to a BOOL that receives zero if none of the text covered by pRange has any audio data or nonzero otherwise.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_INVALIDARG
 One or more parameters are invalid.
E_OUTOFMEMORY
 A memory allocation failure occurred.

Remarks

The current implementation of this method is simple. It clones pRange, places the clone in ppNewRange, sets pfPlayable to TRUE and returns S_OK.

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

ITfFnPlayBack

ITfRange