IPropertyBag2::Read


		Contents Index Topic Contents
	Previous Topic: IPropertyBag2::LoadObject Next Topic: IPropertyBag2::Write

IPropertyBag2::Read
HRESULT Read(
    [in] ULONG cProperties,
    [in] PROPBAG2 * pPropBag,
    [in] IErrorLog * pErrLog,
    [out] VARIANT * pvarValue,
    [out] HRESULT * phrError
);
Causes one or more properties to be read from the property bag.

Returns one of the following values:

S_OK All of the properties were successfully read.
E_FAIL One or more of the properties was not successfully read. It is possible that one or more properties were successfully read. The array at phrError will contain a success or error code for each property. If the caller supplied an IErrorLog for pErrLog, a more descriptive error will be added.

cProperties
[in] Number of properties to read. This argument specifies the number of elements in the arrays at pPropBag, pvarValue and phrError.
pPropBag
[in] Address of an array of PROPBAG2 structures that specify the properties being requested. The vt and pstrName members of these structures must be filled in before calling this method. The dwHint member of these structures is optional. There must be at least cProperties elements in this array. This argument cannot be NULL.
pErrLog
[in] Address of an IErrorLog interface in which the property bag stores any errors that occur during the reads. This argument can be NULL; in that case, the caller is not interested in logging errors.
pvarValue
[out] Address of an array of VARIANT structures that receive the property values. The caller does not need to initialize these structures before calling Read. The Read method will fill both type and value fields in these structures before returning. There must be at least cProperties elements in this array. The calling application is responsible for freeing any allocations that are contained in these structures. This argument cannot be NULL.
phrError
[out] Address of an array of HRESULT values that will receive the result of each property read. There must be at least cProperties elements in this array. This argument cannot be NULL.

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

S_OK	All of the properties were successfully read.
E_FAIL	One or more of the properties was not successfully read. It is possible that one or more properties were successfully read. The array at phrError will contain a success or error code for each property. If the caller supplied an IErrorLog for pErrLog, a more descriptive error will be added.