Fonction StgOpenLayoutDocfile (objbase.h)

Article
02/29/2024

Non pris en charge.

La fonction StgOpenLayoutDocfile ouvre un fichier composé sur une implémentation ILockBytes capable de surveiller les données du secteur. Pour appeler StgOpenLayoutDocfile, DfLayout.dll et DfLayout.lib sont requis.

Note N’utilisez pas cette fonction. Utilisez plutôt la méthode IStorage ::CopyTo . CopyTo peut être utilisé pour mettre en page un docfile, améliorant ainsi les performances dans la plupart des scénarios.

Syntaxe

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

Paramètres

[in] pwcsDfName

Pointeur vers le nom de chaîne Unicode terminé par null du fichier composé à ouvrir.

[in] grfMode

Mode d’accès à utiliser lors de l’ouverture de l’objet de stockage nouvellement créé. Les valeurs sont extraites des constantes STGM. N’oubliez pas que le mode de priorité et les exclusions ne sont pas pris en charge. Le mode d’accès le plus courant est probablement STGM_DIRECT | STGM_READ | STGM_SHARE_EXCLUSIVE.

[in] reserved

Réservé pour un usage futur.

[out] ppstgOpen

Pointeur vers la variable de pointeur IStorage qui reçoit le pointeur d’interface vers l’objet racine de l’objet de stockage racine nouvellement créé.

Valeur retournée

Cette fonction prend en charge les valeurs de retour standard E_OUTOFMEMORY, E_UNEXPECTED, E_INVALIDARG et E_FAIL, en plus des éléments suivants :

La fonction StgOpenLayoutDocfile peut également retourner l’une des valeurs d’erreur retournées par la fonction StgOpenStorageOnILockBytes .

Remarques

L’implémentation de fichier composé créée par cette fonction expose l’interface ILayoutStorage sur son stockage racine. Les applications utilisent cette interface pour exprimer la disposition optimale de leurs fichiers composés afin de télécharger et de restituer des données plus rapidement via un lien lent. StgOpenLayoutDocfile retourne un pointeur vers l’interface IStorage sur le stockage racine du fichier composé nouvellement créé. À l’aide de ce pointeur, les applications appellent QueryInterface pour obtenir un pointeur vers ILayoutStorage.