IPersistPropertyBag::Load
A version of this page is also available for
4/8/2010
This method instructs the object to initialize itself by using the properties available in the property bag, notifying the provided error log object when errors occur.
Syntax
HRESULT Load(
IPropertyBag* pPropBag,
IErrorlog* pErrorLog
);
Parameters
pPropBag
[in] Address of the caller's property bag, through which the object can read properties.This cannot be NULL.
pErrorLog
[in] Address of the caller's error log, in which the object stores any errors that occur during initialization.This can be NULL. If it is NULL, the caller does not receive errors.
Return Value
The following table shows the return values.
| Value | Description |
|---|---|
S_OK |
The object successfully initialized itself. |
E_UNEXPECTED |
This member was called after IPersistPropertyBag::InitNew had already been called. These two initialization methods are mutually exclusive. |
E_POINTER |
The address in pPropBag is not valid and therefore the object cannot initialize itself. If the value of pPropBag is NULL, the method returns E_POINTER. |
E_FAIL |
The object was unable to retrieve a property that is necessary for the object's successful operation. The object was unable to initialize itself completely. |
Remarks
All property loading must take place within the IPersistPropertyBag::Load function call because the object cannot hold the IPropertyBag pointer.
E_NOTIMPL is not a valid return code because any object implementing this interface must support the entire functionality of the interface.
Requirements
| Header | ocidl.h, ocidl.idl |
| Library | ole32.lib, uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
IPersistPropertyBag:IPersist
IPropertyBag
IPersistPropertyBag::InitNew
IPersistPropertyBag::Save