IWiaItem::DeleteItem method (wia_xp.h)

Article
02/22/2024

The IWiaItem::DeleteItem method removes the current IWiaItem object from the object tree of the device.

Syntax

HRESULT DeleteItem(
  [in] LONG lFlags
);

Parameters

[in] lFlags

Type: LONG

Currently unused. Should be set to zero.

Return value

Type: HRESULT

This method returns S_OK regardless of how many items were deleted. If the method fails, it returns a standard COM error code.

Remarks

The Windows Image Acquisition (WIA) run-time system represents each WIA hardware device connected to the user's computer as a hierarchical tree of IWiaItem objects. A given WIA device may or may not allow applications to delete IWiaItem objects from its tree. Use the IEnumWIA_DEV_CAPS interface to query the device for item deletion capability.

If the device supports item deletion in its IWiaItem tree, invoke the IWiaItem::DeleteItem method to remove the IWiaItem object. Note that this method will only delete an object after all references to the object have been released.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	wia_xp.h (include Wia.h)
Library	Wiaguid.lib
DLL	Wiaservc.dll

Share via