IOleDocument::GetDocMiscStatus

Obtains information about whether a document object supports behaviors specified in the DOCMISC enumerator.

HRESULT GetDocMiscStatus(
  DWORD *pdwStatus  // Pointer to information about the document 
                    // object
);

Parameters

pdwStatus: [out] Pointer to the information on supported behaviors. Values written to the address specified by this pointer are taken from the DOCMISC enumeration.

Return Values

S_OK: The information was obtained successfully
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.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in docobj.h.