Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ITfCompartment::GetValue method

Syntax


HRESULT GetValue(
  [out]  VARIANT *pvarValue
);

Parameters

pvarValue [out]

Pointer to a VARIANT structure that receives the data. This receives VT_EMPTY if the compartment has no value. The caller must free this data when it is no longer required by calling VariantClear.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

S_FALSE

The compartment has no value. pvarValue receives VT_EMPTY.

E_UNEXPECTED

The compartment has been cleared by a call to ITfCompartmentMgr::ClearCompartment.

E_INVALIDARG

pvarValue is invalid.

 

Remarks

The caller must recognize the supplied data format in order to use the data. The compartment installer must publish the data format to enable other clients to use it.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps | Windows Store apps]

Minimum supported server

Windows 2000 Server [desktop apps | Windows Store apps]

Redistributable

TSF 1.0 on Windows 2000 Professional

Header

Msctf.h

IDL

Msctf.idl

DLL

Msctf.dll

See also

ITfCompartment
VariantClear
ITfCompartmentMgr::ClearCompartment

 

 

Community Additions

Show:
© 2014 Microsoft. All rights reserved.