IPersistPropertyBag
Collapse the table of content
Expand the table of content

IPersistPropertyBag interface

Works with IPropertyBag and IErrorlog to define an individual property-based persistence mechanism.

Members

The IPersistPropertyBag interface inherits from IPersist. IPersistPropertyBag also has these types of members:

Methods

The IPersistPropertyBag interface has these methods.

MethodDescription
InitNew

Informs the object that it is being initialized as a newly created object.

Load

Instructs the object to initialize itself using the properties available in the property bag, and to notify the provided error log object when errors occur.

Save

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

 

Remarks

A mechanism such as IPersistStream gives an object an IStream in which to store its binary data, while IPersistPropertyBag provides an object with an IPropertyBag interface through which it can save and load individual properties. The object that implements IPropertyBag can then save those properties in various ways, such as name/value pairs in a text file. Errors encountered in the process (on either side) are recorded in an error log through IErrorlog. This error reporting mechanism works on a per-property basis instead of on all properties at once.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Ocidl.h

IDL

Ocidl.idl

 

 

Show:
© 2016 Microsoft