ITfContext::GetDocumentMgr method

Syntax


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

Parameters

ppDm [out]

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

Return value

This method can return one of these values.

ValueDescription
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

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

ITfContext
ITfDocumentMgr
ITfDocumentMgr::Pop

 

 

Show: