OleSaveToStream, fonction (ole.h)

Enregistre un objet avec l’interface IPersistStream sur celui-ci dans le flux spécifié.

Syntaxe

OLESTATUS OleSaveToStream(
  LPOLEOBJECT unnamedParam1,
  LPOLESTREAM unnamedParam2
);

Paramètres

unnamedParam1

Pointeur vers l’interface IPersistStream sur l’objet à enregistrer dans le flux. Le paramètre pPStm ne peut pas être NULL.

unnamedParam2

Pointeur vers l’interface IStream sur le flux dans lequel l’objet doit être enregistré.

Valeur retournée

Cette fonction retourne S_OK en cas de réussite. Les autres valeurs possibles sont les suivantes.

Code de retour	Description
STGMEDIUM_E_FULL	Impossible d’enregistrer l’objet en raison d’un manque d’espace disque.
OLE_E_BLANK	Le paramètre pPStm est NULL.

 

Cette fonction peut également retourner n’importe quelle valeur d’erreur retournée par la fonction WriteClassStm ou la méthode IPersistStream ::Save .

Remarques

Cette fonction simplifie l’enregistrement d’un objet qui implémente l’interface IPersistStream dans un flux. Dans ce flux, le CLSID de l’objet précède ses données. Lorsque le flux est récupéré, le CLSID permet d’associer le code approprié aux données. La fonction OleSaveToStream effectue les opérations suivantes :

• Appelle la méthode IPersist ::GetClassID pour obtenir le CLSID de l’objet.
• Écrit le CLSID dans le flux avec la fonction WriteClassStm .
• Appelle la méthode IPersistStream ::Save avec fClearDirty défini sur TRUE, ce qui efface le bit sale dans l’objet.

L’assistance complémentaire , OleLoadFromStream, charge les objets enregistrés de cette façon.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	ole.h (inclure Ole2.h)
Bibliothèque	Ole32.lib
DLL	Ole32.dll
Ensemble d’API	ext-ms-win-com-ole32-l1-1-1 (introduit dans Windows 8.1)

Voir aussi

IPersistStream

IStream

OleLoadFromStream