ISearchProtocol::Init method (searchapi.h)

Article
02/22/2024

Initializes a protocol handler.

Syntax

HRESULT Init(
  [in] TIMEOUT_INFO         *pTimeoutInfo,
  [in] IProtocolHandlerSite *pProtocolHandlerSite,
  [in] PROXY_INFO           *pProxyInfo
);

Parameters

[in] pTimeoutInfo

Type: TIMEOUT_INFO*

Pointer to a TIMEOUT_INFO structure that contains information about connection time-outs.

[in] pProtocolHandlerSite

Type: IProtocolHandlerSite*

Pointer to an IProtocolHandlerSite interface that enables protocol handlers to access IFiltear within the filter host.

[in] pProxyInfo

Type: PROXY_INFO*

Pointer to a PROXY_INFO structure that contains information about the proxy settings necessary for accessing items in the content source.

Return value

Type: HRESULT

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

Remarks

After the protocol handler is created, this method is called to perform any initialization specific to the protocol handler. This method is not called again.

Because the protocol host may unexpectedly terminate before calling ISearchProtocol::ShutDown, protocol handlers with persistent information, such as temporary files and registry entries, should do an initial clean-up of resources previously opened in this method before starting the current instance.

Requirements

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

Share via