IWiaItem::FindItemByName method (wia_xp.h)

Article
02/22/2024

The IWiaItem::FindItemByName method searches an item's tree of sub-items using the name as the search key. Each IWiaItem object has a name as one of its standard properties.

Syntax

HRESULT FindItemByName(
  [in]  LONG     lFlags,
  [in]  BSTR     bstrFullItemName,
  [out] IWiaItem **ppIWiaItem
);

Parameters

[in] lFlags

Type: LONG

Currently unused. Should be set to zero.

[in] bstrFullItemName

Type: BSTR

Specifies the name of the item for which to search.

[out] ppIWiaItem

Type: IWiaItem**

Pointer to the IWiaItem interface.

Return value

Type: HRESULT

This method returns S_OK if it finds the item, or S_FALSE if it does not find the item. If the method fails, it returns a standard COM error code.

Remarks

This method searches the current item's tree of sub-items using the name as the search key. If IWiaItem::FindItemByName finds the item specified by bstrFullItemName, it stores the address of a pointer to the IWiaItem interface of the item in the ppIWiaItem parameter.

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