ITfCompartment::SetValue method

Syntax


HRESULT SetValue(
  [in]  const TfClientId tid,
  [in]  VARIANT *pvarValue
);

Parameters

tid [in]

Contains a TfClientId value that identifies the client.

pvarValue [in]

Pointer to a VARIANT structure that contains the data to be set. Only VT_I4, VT_UNKNOWN and VT_BSTR data types are allowed.

Return value

This method can return one of these values.

ValueDescription
S_OK

The method was successful.

E_FAIL

An unspecified error occurred.

E_INVALIDARG

pvarValue is invalid.

E_UNEXPECTED

The compartment was cleared by a call to ITfCompartmentMgr::ClearCompartment, this method was called during a ITfCompartmentEventSink::OnChange notification or only the owner can clear this compartment.

 

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
TfClientId

 

 

Community Additions

ADD
Show:
© 2014 Microsoft