IPropertyBag::Read method (oaidl.h)

Reads the named property into a caller-initialized VARIANT.

Syntax

HRESULT Read(
  LPCOLESTR pszPropName,
  VARIANT   *pVar,
  IErrorLog *pErrorLog
);

Parameters

pszPropName

The address of the name of the property to read. This cannot be NULL.

pVar

The address of the caller-initialized VARIANT that receives the property value on output. The function sets the type field and the value field in the VARIANT before it returns. If the caller initialized the pVar->vt field on entry, the property bag attempts to change its corresponding value to this type. If the caller sets pVar->vt to VT_EMPTY, the property bag can use whatever type is convenient.

pErrorLog

The address of the caller's error log in which the property bag stores any errors that occur during reads. This can be NULL; in which case, the caller does not receive errors.

Return value

An HRESULT

Remarks

The Read method tells the property bag to read the property named in pszPropName to the caller-initialized VARIANT in pVar. Errors are logged in the error log that is pointed to by pErrorLog. When pVar->vt specifies another object pointer (VT_UNKNOWN), the property bag is responsible for creating and initializing the object described by pszPropName.

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

Requirements

Requirement	Value
Minimum supported client	Windows 10 Build 20348
Minimum supported server	Windows 10 Build 20348
Header	oaidl.h