Share via

IDSFPropertyBag::Remove Method

  • Article

The Remove method deletes a value from a property bag.

Syntax

HRESULT Remove(
  [in]  BSTR Name
);

Parameters

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

Return Value

Remove returns one of the following values:

Return code Description
S_OK

Remove successfully removed the property that the Name parameter specifies.
E_INVALIDARG

The length of the string that Name specifies is 0.

 

Remarks

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

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

Requirements

Header

 DSFif.h

 

 

Send comments about this topic to Microsoft

Build date: 9/21/2010