Método IOleDocument::GetDocMiscStatus (docobj.h)

Recupera status informações sobre o objeto do documento.

Sintaxe

HRESULT GetDocMiscStatus(
  [out] DWORD *pdwStatus
);

Parâmetros

[out] pdwStatus

Um ponteiro para as informações sobre comportamentos com suporte. Os valores possíveis são obtidos da enumeração DOCMISC .

Valor retornado

Esse método retorna S_OK em caso de êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno Descrição
E_POINTER
O endereço em pdwStatus é NULL.

Comentários

Esse método fornece uma maneira para os contêineres verificarem se um objeto de documento dá suporte a vários modos de exibição, retângulos complexos, abertura em uma janela pop-up ou leitura/gravação de arquivo.

Os valores desse enumerador também são armazenados no Registro como o valor da chave DocObject.

Anotações aos Chamadores

Ao chamar esse método antes de ativar um objeto de documento, os contêineres podem tomar todas as etapas necessárias para dar suporte ou acomodar os comportamentos especificados.

Observações aos implementadores

Esse método deve ser completamente implementado em qualquer objeto de documento, mesmo que o valor desreferenciado de pdwStatus seja zero. E_NOTIMPL não é um valor retornado aceitável. Normalmente, o valor DOCMISC retornado deve ser embutido em código para desempenho.

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho docobj.h

Confira também

DOCMISC

Ioledocument