Edit

ITfCompartmentMgr::GetCompartment method (msctf.h)

  • Article

Obtains the compartment object for a specified compartment.

Syntax

HRESULT GetCompartment(
  [in]  REFGUID        rguid,
  [out] ITfCompartment **ppcomp
);

Parameters

[in] rguid

Contains a GUID that identifies the compartment.

[out] ppcomp

Pointer to an ITfCompartment interface pointer that receives the compartment object.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
E_INVALIDARG
 ppcomp is invalid.
E_OUTOFMEMORY
 A memory allocation failure occurred.

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