IWiaItem::GetRootItem method (wia_xp.h)

Article
02/22/2024

The IWiaItem::GetRootItem method retrieves the root item of a tree of item objects used to represent a Windows Image Acquisition (WIA) hardware device.

Syntax

HRESULT GetRootItem(
  [out] IWiaItem **ppIWiaItem
);

Parameters

[out] ppIWiaItem

Type: IWiaItem**

Receives the address of a pointer to the IWiaItem interface that contains a pointer to the IWiaItem interface of the root item.

Return value

Type: HRESULT

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

Remarks

Given any IWiaItem object in the object tree of a WIA hardware device, the application retrieves a pointer to the root item by calling this function.

Applications must call the IUnknown::Release method on the interface pointers they receive through the ppIWiaItem parameter.

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