IOleDocument::GetDocMiscStatus

Returns information about whether a document object supports behaviors specified in the DOCMISC enumerator. Values from this enumerator are also stored in the registry as the value of the “DocObject” key.

HRESULT GetDocMiscStatus(

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

Parameters

pdwStatus

[out] On return, a pointer to the information on supported behaviors; may be NULL. Values written to this pointer are taken from the DOCMISC enumeration.

Return Values

S_OK

The status bits were returned 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.

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 function must be completely implemented in any document object even if a zero is returned; therefore E_NOTIMPL is not an acceptable return value. Normally, the returned DOCMISC value should be hard-coded for performance.

See Also

DOCMISC