ISearchQueryHelper::get_ConnectionString method (searchapi.h)

Article
02/22/2024

Returns the OLE DB connection string for the Window Search index.

Syntax

HRESULT get_ConnectionString(
  [out, retval] LPWSTR *pszConnectionString
);

Parameters

[out, retval] pszConnectionString

Type: LPWSTR*

Receives a pointer to a null-terminated Unicode string that is a valid OLE DB connection string. This connection string can be used to initialize a connection to the Windows Search index and submit the SQL query returned by ISearchQueryHelper::GenerateSQLFromUserQuery.

Return value

Type: HRESULT

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

Remarks

A connection string is a string version of the initialization properties needed to connect to a data store. The string can include such things as a data source, data source name, or user ID and password.

Checkout the DSearch code sample to see how to create a class for a static console application to query Windows Search using the Microsoft.Search.Interop assembly for ISearchQueryHelper.

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