Edit

ITfContext::GetDocumentMgr method (msctf.h)

  • Article

Obtains the document manager that contains the context.

Syntax

HRESULT GetDocumentMgr(
  [out] ITfDocumentMgr **ppDm
);

Parameters

[out] ppDm

Pointer to an ITfDocumentMgr interface pointer that receives the document manager.

Return value

This method can return one of these values.

Value Description
S_OK
 The method was successful.
S_FALSE
 The context is not contained in any document manager. ppDm is set to NULL.
E_INVALIDARG
 ppDm is invalid.

Remarks

If the context is not contained within a document manager, this method returns S_FALSE and ppDm is set to NULL. This occurs when the context is removed from the context stack through a call to ITfDocumentMgr::Pop.

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, ITfDocumentMgr interface, ITfDocumentMgr::Pop