ITfCompartmentMgr::ClearCompartment method (Windows)

Switch View :
ScriptFree
ITfCompartmentMgr::ClearCompartment method

Applies to: desktop apps | Metro style apps

Syntax

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

Parameters

tid [in]

Contains a TfClientId value that identifies the client.

rguid [in]

Contains a GUID that identifies the compartment.

Return value

This method can return one of these values.

ValueDescription
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

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfCompartmentMgr
TfClientId

 

 

Send comments about this topic to Microsoft

Build date: 2/15/2012