ISearchManager::put_UserAgent method (searchapi.h)

2024-02-22

Sets the user agent string that a user agent passes to website and services to identify itself.

Syntax

HRESULT put_UserAgent(
  [in] LPCWSTR pszUserAgent
);

Parameters

[in] pszUserAgent

Type: LPCWSTR

The user agent string identifying the user agent.

Return value

Type: HRESULT

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

Remarks

A user agent is a client application that accesses the Internet. User agents include web browsers, search engine crawlers, download managers, and so on, and may be associated with a specific protocol such as File Transfer Protocol (FTP) or Hyper Text Transfer Protocol (HTTP).

Each user agent typically has a user agent string, such as "Mozilla/4.0", that it can pass to websites and services to identify itself.

Check out the ReindexMatchingUrls code sample to see ways to specify which files to re-index and how set it up.

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