| description | title | ms.date | f1_keywords | helpviewer_keywords | ms.assetid | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Learn more about: IPersistPropertyBagImpl Class |
IPersistPropertyBagImpl Class |
11/04/2016 |
|
|
712af24d-99f8-40f2-9811-53b3ff6e5b19 |
This class implements IUnknown and allows an object to save its properties to a client-supplied property bag.
Important
This class and its members cannot be used in applications that execute in the Windows Runtime.
template <class T>
class ATL_NO_VTABLE IPersistPropertyBagImpl : public IPersistPropertyBag
T
Your class, derived from IPersistPropertyBagImpl.
| Name | Description |
|---|---|
| IPersistPropertyBagImpl::GetClassID | Retrieves the object's CLSID. |
| IPersistPropertyBagImpl::InitNew | Initializes a newly created object. The ATL implementation returns S_OK. |
| IPersistPropertyBagImpl::Load | Loads the object's properties from a client-supplied property bag. |
| IPersistPropertyBagImpl::Save | Saves the object's properties into a client-supplied property bag. |
The IPersistPropertyBag interface allows an object to save its properties to a client-supplied property bag. Class IPersistPropertyBagImpl provides a default implementation of this interface and implements IUnknown by sending information to the dump device in debug builds.
IPersistPropertyBag works in conjunction with IPropertyBag and IErrorLog. These latter two interfaces must be implemented by the client. Through IPropertyBag, the client saves and loads the object's individual properties. Through IErrorLog, both the object and the client can report any errors encountered.
Related Articles ATL Tutorial, Creating an ATL Project
IPersistPropertyBag
IPersistPropertyBagImpl
Header: atlcom.h
Retrieves the object's CLSID.
STDMETHOD(GetClassID)(CLSID* pClassID);
See IPersist::GetClassID in the Windows SDK.
Initializes a newly created object.
STDMETHOD(InitNew)();
Returns S_OK.
See IPersistPropertyBag::InitNew in the Windows SDK.
Loads the object's properties from a client-supplied property bag.
STDMETHOD(Load)(LPPROPERTYBAG pPropBag, LPERRORLOG pErrorLog);
ATL uses the object's property map to retrieve this information.
See IPersistPropertyBag::Load in the Windows SDK.
Saves the object's properties into a client-supplied property bag.
STDMETHOD(Save)(
LPPROPERTYBAG pPropBag,
BOOL fClearDirty,
BOOL fSaveAllProperties);
ATL uses the object's property map to store this information. By default, this method saves all properties, regardless of the value of fSaveAllProperties.
See IPersistPropertyBag::Save in the Windows SDK.