Contents Index Topic Contents
	Previous Topic: IPersistPropertyBag2::Load Next Topic: The IPropertyBag2 Interface

IPersistPropertyBag2::Save

HRESULT Save(
    IPropertyBag *pPropBag, 
    BOOL fClearDirty, 
    BOOL fSaveAllProperties
);

Instructs the object to save its properties to the given property bag, optionally clearing the object's "dirty" flag. The caller can request that the object save all properties or that the object save only those known to have changed.

• Returns one of the following values:

  S_OK	The object successfully saved the requested properties itself.
  E_FAIL	One or more essential properties could not be saved. The object can choose to succeed (return S_OK) if all essential properties could be saved but one or more non-essential properties could not be saved.
  E_POINTER	The address in pPropBag is not valid (such as NULL) and, therefore, the object cannot initialize itself.

pPropBag

[in] Address of the caller's IPropertyBag2 interface through which the object can write properties. This argument cannot be NULL.

fClearDirty

[in] Flag indicating whether the object should clear its dirty flag when saving is complete. If this argument is nonzero, the dirty flag should be cleared. If this argument is zero, the dirty flag should not be changed. Zero is used when the caller wants to do a "Save Copy As" operation.

fSaveAllProperties

[in] Flag indicating whether the object should save all its properties or only those that have changed from their default values. If this argument is nonzero, all properties should be saved. If this argument is zero, only those properties that have changed from their default values should be saved.

E_NOTIMPL is not a valid return code because any object implementing this interface must support the entire functionality of the interface.

---

 Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.