Save method

  • Article

Instructs the object to save its properties to the given property bag, and optionally, to clear the object's "dirty" flag.

Syntax

HRESULT retVal = object.Save(pPropBag, fClearDirty, fSaveAllProperties);

Parameters

  • pPropBag [in]
    Type: IPropertyBag2

    The address of the caller's IPropertyBag2 interface, through which the object can write properties. This argument cannot be NULL.

  • fClearDirty [in]
    Type: BOOL

    A flag indicating whether the object clears its "dirty" flag when the "Save" operation is complete. If this argument is nonzero, the flag is cleared. If this argument is zero, the flag is not changed. Zero is used when the caller performs a "Save Copy As" operation.

  • fSaveAllProperties [in]
    Type: BOOL

    A flag indicating whether the object should save all its properties, or save only those properties that have changed from their default values. If this argument is nonzero, all properties are saved. If this argument is zero, only those properties that have changed from their default values are saved.

Remarks

The caller can request that the object save all properties, or save only those properties that have changed.

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