Edit

Share via

ITfCompartmentMgr::ClearCompartment method (msctf.h)

  • Article

Removes the specified compartment.

Syntax

HRESULT ClearCompartment(
  [in] TfClientId tid,
  [in] REFGUID    rguid
);

Parameters

[in] tid

Contains a TfClientId value that identifies the client.

[in] rguid

Contains a GUID that identifies the compartment.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
CONNECT_E_NOCONNECTION
 The compartment cannot be found.
E_FAIL
 An unspecified error occurred.
E_UNEXPECTED
 The owner must clear this compartment.

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 Msctf.dll
Redistributable TSF 1.0 on Windows 2000 Professional

See also

ITfCompartmentMgr interface, ITfCompartment interface, Compartments