GetDocMiscStatus Method
Collapse the table of content
Expand the table of content

IOleDocument::GetDocMiscStatus method

Retrieves status information about the document object.

Syntax


HRESULT GetDocMiscStatus(
  [out] DWORD *pdwStatus
);

Parameters

pdwStatus [out]

A pointer to the information on supported behaviors. Possible values are taken from the DOCMISC enumeration.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return codeDescription
E_POINTER

The address in pdwStatus is NULL.

 

Remarks

This method provides a way for containers to ascertain whether a document object supports multiple views, complex rectangles, opening in a pop-up window, or file read/write.

Values from this enumerator are also stored in the registry as the value of the DocObject key.

Notes to Callers

By calling this method prior to activating a document object, containers can take whatever steps are necessary to support or otherwise accommodate the specified behaviors.

Notes to Implementers

This method must be completely implemented in any document object, even if the dereferenced value of pdwStatus is zero. E_NOTIMPL is not an acceptable return value. Normally, the returned DOCMISC value should be hard-coded for performance.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

DocObj.h

IDL

DocObj.Idl

IID

IID_IOleDocument is defined as b722bcc5-4e68-101b-a2bc-00aa00404770

See also

IOleDocument
DOCMISC

 

 

Show:
© 2016 Microsoft