ISearchProtocol2::CreateAccessorEx method (searchapi.h)

Article
10/13/2021

Creates and initializes an IUrlAccessor object. This method has the same basic functionality as the ISearchProtocol::CreateAccessor method, but it includes an additional pUserData parameter to supply additional data to the protocol handler.

Syntax

HRESULT CreateAccessorEx(
  [in]  LPCWSTR                 pcwszURL,
  [in]  AUTHENTICATION_INFO     *pAuthenticationInfo,
  [in]  INCREMENTAL_ACCESS_INFO *pIncrementalAccessInfo,
  [in]  ITEM_INFO               *pItemInfo,
  [in]  const BLOB              *pUserData,
  [out] IUrlAccessor            **ppAccessor
);

Parameters

[in] pcwszURL

Type: LPCWSTR

Pointer to a null-terminated Unicode string containing the URL of the item being accessed.

[in] pAuthenticationInfo

Type: AUTHENTICATION_INFO*

Pointer to an AUTHENTICATION_INFO structure that contains authentication information necessary for accessing this item in the content source.

[in] pIncrementalAccessInfo

Type: INCREMENTAL_ACCESS_INFO*

Pointer to an INCREMENTAL_ACCESS_INFO structure that contains incremental access information, such as the last time the file was accessed by the gatherer.

[in] pItemInfo

Type: ITEM_INFO*

Pointer to an ITEM_INFO structure that contains information about the URL item, such as the name of the item's workspace catalog.

[in] pUserData

Type: const BLOB*

Pointer to user information. This data can be whatever the notification originator decides. If the protocol handler implements this interface, it will receive this data. Not all notifications have this blob set.

[out] ppAccessor

Type: IUrlAccessor**

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

Return value

Type: HRESULT

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

Remarks

This method creates and initializes an IUrlAccessor object to process an item currently being accessed by the gatherer. The protocol host calls this method on the protocol handler. This method is called once for every URL processed by the gatherer and retrieves a pointer to the IUrlAccessor object.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Desktop Search (WDS) 3.0

Share via