Edit

Share via

ITfContextOwnerCompositionSink::OnStartComposition method (msctf.h)

  • Article

Called when a composition is started.

Syntax

HRESULT OnStartComposition(
  [in]  ITfCompositionView *pComposition,
  [out] BOOL               *pfOk
);

Parameters

[in] pComposition

Pointer to an ITfCompositionView object that represents the new composition.

[out] pfOk

Pointer to a BOOL value that receives a value that allows or denies the new composition. Receives a nonzero value to allow the composition or zero to deny the composition.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header msctf.h
DLL Msimtf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfCompositionView interface, ITfContextOwnerCompositionSink interface