IWiaItem2::DeleteItem method

Removes the current IWiaItem2 object from the device's object tree.

Syntax

HRESULT DeleteItem(
  [in] LONG lFlags
);

Parameters

lFlags [in]

Type: LONG

Currently unused. Should be set to zero.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The Windows Image Acquisition (WIA) 2.0 run-time system represents each WIA 2.0 hardware device connected to the user's computer as a hierarchical tree of IWiaItem2 objects. A given WIA 2.0 device may or may not allow applications to delete IWiaItem2 objects from its tree. Items that have children cannot be deleted. The IEnumWIA_DEV_CAPS interface must be used to query the device for item deletion capability.

If the device supports item deletion in its IWiaItem2 tree, call the IWiaItem2::DeleteItem method to remove the IWiaItem2 object. Note that this method only deletes an object after all references to the object have been released. If the deletion of an item has failed, E_DELETEITEM is returned. The numeric value for this error is not yet defined.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	Wia.h
IDL	Wia.idl