Share via

IDSFPropertyBag::Read Method

  • Article

The Read method reads a named value from the property bag.

Syntax

HRESULT Read(
  [in]           BSTR Name,
  [out, retval]  VARIANT *Value
);

Parameters

  • Name [in]
    The name of the property to read.

  • Value [out, retval]
    A pointer to a caller-allocated VARIANT in which to return the value of the property.

Return Value

Read returns one of the following values:

Return code Description
S_OK

Read successfully wrote the value to the space that the *Value parameter specifies.
E_INVALIDARG

The length of the string that the Name parameter specifies is 0, or Value is not a valid pointer.

 

Remarks

The following VBScript code example shows how to read a value from a DSFPropertyBag object.

Dim PropBag : Set PropBag = CreateObject("DSF.DSFPropertyBag")
PropBag.Write "TestPassed", TRUE
Dim fTestPassed : fTestPassed = PropBag.Read("TestPassed")

Requirements

Header

 DSFif.h

 

 

Send comments about this topic to Microsoft

Build date: 9/21/2010