ITfContext::InWriteSession method (msctf.h)

Determines if a client has a read/write lock on the context.

Syntax

HRESULT InWriteSession(
  [in]  TfClientId tid,
  [out] BOOL       *pfWriteSession
);

Parameters

[in] tid

Contains a TfClientID value that identifies the client.

[out] pfWriteSession

Pointer to a BOOL that receives a nonzero value if the client has a read/write lock on the context. Receives zero if the client does not have an edit session or has a read-only edit session.

Return value

This method can return one of these values.

Value Description
S_OK
The method was successful.
E_INVALIDARG
pfWriteSession is invalid.

Remarks

A client uses this method, from inside a notification callback, to determine if it must make the change.

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

ITfContext interface