IDSFPropertyBag Interface

The IDSFPropertyBag interface is the dual interface on the DSFPropertyBag object. The DSFPropertyBag object implements a generic property bag. A property bag is a container of an arbitrary set of name-value pairs where the name can be any character string and the value is a VARIANT. Property bags are often used to hold contextual data that is associated with another object. For example, SoftUSBDevice.Context references a DSFPropertyBag object that device simulators and test applications can use to store context, such as device state or test case parameters together with the SoftUSBDevice object.

A name-value pair is created the first time a name is written to the property bag with the Write method. Subsequent writes to the same name update the value.

The VARIANT can contain any OLE-automation compatible data type but if it contains an object type (VT_UNKNOWN or VT_DISPATCH), the VARIANT must reference another DSF object.

Members

The IDSFPropertyBag interface inherits from the IDispatch interface. IDSFPropertyBag also defines the following types of members:

  • Methods

Methods

The IDSFPropertyBag interface defines the following methods.

Method Description
Write

Writes a value to the property bag.

Read

Reads data value from the property bag.

Remove

Removes a value from the property bag.

Clear

Removes all name-value pairs from the property bag.

 

Requirements

IDL

Dsfif.idl

 

 

Send comments about this topic to Microsoft

Build date: 9/21/2010