ISearchProtocolUI::GetSearchItemForUrl method

Gets the search item for the data specified. This method is called once for every URL processed by the gatherer, and retrieves a pointer to the ISearchItem object.


HRESULT GetSearchItemForUrl(
  [in]          LPCOLESTR        pcwszURL,
  [in]          IItemPropertyBag *pPropertyBag,
  [out, retval] ISearchItem      **ppSearchItem


pcwszURL [in]


Pointer to a null data terminated Unicode string containing the search item for the URL being accessed.

pPropertyBag [in]

Type: IItemPropertyBag*

Pointer to an IItemPropertyBag object that contains information about the search item, including the properties of the item.

ppSearchItem [out, retval]

Type: ISearchItem**

Receives the address of a pointer to the ISearchItem object created by this method. This object contains information about the search item, such as the item's file name.

Return value


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


The ISearchProtocolUI::GetSearchItemForUrl method is supported only on Windows XP and Windows Server 2003, and should no longer be used.

To preview attachments with a third-party protocol handler on computers running Windows XP or Windows Server 2003, it may be necessary to use the ISearchProtocolUI interface, and the following APIs: the IItemPreviewerExt, IItemPropertyBag and ISearchItem interfaces, the LINKINFO structure, and the LINKTYPE enumeration.


Requirement Value
Minimum supported client
Windows XP with SP2 [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Windows Desktop Search (WDS) 3.0

See also