IPropertyBag2.Read Method
Reads one or more properties from the property bag.
Namespace: Microsoft.VisualStudio.OLE.Interop
Assembly: Microsoft.VisualStudio.OLE.Interop (in Microsoft.VisualStudio.OLE.Interop.dll)
Syntax
'Declaration
Sub Read ( _
cProperties As UInteger, _
pPropBag As PROPBAG2(), _
pErrLog As IErrorLog, _
<OutAttribute> ByRef pvarValue As Object, _
<OutAttribute> ByRef phrError As Integer _
)
void Read(
uint cProperties,
PROPBAG2[] pPropBag,
IErrorLog pErrLog,
out Object pvarValue,
out int phrError
)
void Read(
[InAttribute] unsigned int cProperties,
[InAttribute] array<PROPBAG2>^ pPropBag,
[InAttribute] IErrorLog^ pErrLog,
[OutAttribute] Object^% pvarValue,
[OutAttribute] int% phrError
)
abstract Read :
cProperties:uint32 *
pPropBag:PROPBAG2[] *
pErrLog:IErrorLog *
pvarValue:Object byref *
phrError:int byref -> unit
function Read(
cProperties : uint,
pPropBag : PROPBAG2[],
pErrLog : IErrorLog,
pvarValue : Object,
phrError : int
)
Parameters
cProperties
Type: System.UInt32[in] The number of properties to read. This argument specifies the number of elements in the arrays at pPropBag, pvarValue, and phrError.
pPropBag
Type: array<Microsoft.VisualStudio.OLE.Interop.PROPBAG2[][in[ An array of PROPBAG2 structures that specify the properties that are requested. The vt and pstrName members of these structures must be filled in before this method can be called. The dwHint member of these structures is optional. There must be at least cProperties elements in this array. This argument cannot be NULL.
pErrLog
Type: Microsoft.VisualStudio.OLE.Interop.IErrorLog[in] An IErrorLog interface in which the property bag stores any errors that occur during the reads. This argument can be NULL, in which case, the caller receives no logging errors.
pvarValue
Type: System.Object%[out] An array of VARIANT structures that receive the property values. The caller does not have to initialize these structures before calling Read. The Readmethod fills the type and value fields in these structures before it returns. There must be at least cProperties elements in this array. The calling application is frees any allocations contained in these structures. This argument cannot be NULL.
phrError
Type: System.Int32%[out] An array of HRESULT values that receives the result of each property read. There must be at least cProperties elements in this array. This argument cannot be NULL.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.