Função StgOpenLayoutDocfile (objbase.h)

Artigo
02/29/2024

Não há suporte.

A função StgOpenLayoutDocfile abre um arquivo composto em uma implementação ILockBytes capaz de monitorar dados do setor. Para chamar StgOpenLayoutDocfile, DfLayout.dll e DfLayout.lib são necessários.

Nota Não use essa função. Em vez disso, use o método IStorage::CopyTo . CopyTo pode ser usado para layout de um docfile, melhorando o desempenho na maioria dos cenários.

Sintaxe

HRESULT StgOpenLayoutDocfile(
  [in]  OLECHAR const *pwcsDfName,
  [in]  DWORD         grfMode,
  [in]  DWORD         reserved,
  [out] IStorage      **ppstgOpen
);

Parâmetros

[in] pwcsDfName

Um ponteiro para o nome da cadeia de caracteres Unicode terminada em nulo do arquivo composto a ser aberto.

[in] grfMode

Modo de acesso a ser usado ao abrir o objeto de armazenamento recém-criado. Os valores são obtidos das constantes STGM. Lembre-se de que o modo de prioridade e as exclusões não têm suporte. O modo de acesso mais comum provavelmente será STGM_DIRECT | STGM_READ | STGM_SHARE_EXCLUSIVE.

[in] reserved

Reservado para uso futuro.

[out] ppstgOpen

Um ponteiro para a variável de ponteiro IStorage que recebe o ponteiro de interface para o objeto raiz do objeto de armazenamento raiz recém-criado.

Retornar valor

Essa função dá suporte aos valores retornados padrão E_OUTOFMEMORY, E_UNEXPECTED, E_INVALIDARG e E_FAIL, além do seguinte:

A função StgOpenLayoutDocfile também pode retornar qualquer um dos valores de erro retornados pela função StgOpenStorageOnILockBytes .

Comentários

A implementação de arquivo composto criada por essa função expõe a interface ILayoutStorage em seu armazenamento raiz. Os aplicativos usam essa interface para expressar o layout ideal de seus arquivos compostos para baixar e renderizar dados mais rapidamente em um link lento. StgOpenLayoutDocfile retorna um ponteiro para a interface IStorage no armazenamento raiz do arquivo composto recém-criado. Usando esse ponteiro, os aplicativos chamam QueryInterface para obter um ponteiro para ILayoutStorage.