LoadIFilter function (ntquery.h)

[Indexing Service is unsupported as of Windows XP. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Retrieves IFilter from path name for object.

Syntax

HRESULT LoadIFilter(
        PCWSTR   pwcsPath,
  [in]  IUnknown *pUnkOuter,
  [out] void     **ppIUnk
);

Parameters

pwcsPath

A pointer to the full path of an object for which an IFilter interface pointer is to be returned. The path can include a full filename or only the file name extension; for example, ".ext".

[in] pUnkOuter

A pointer to the controlling IUnknown interface of the aggregate in which this storage object exists.

[out] ppIUnk

A pointer to a variable that receives the IFilter interface pointer.

Return value

This function can return one of these values.

Return code Description
S_OK
The operation was completed successfully.
E_ACCESSDENIED
The function was denied access to the filter file.
E_HANDLE
The function encountered an invalid handle, probably due to a low-memory situation.
E_INVALIDARG
The function received an invalid parameter.
E_OUTOFMEMORY
The function did not have sufficient memory or other resources to complete the operation.
E_FAIL
An unknown error has occurred.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ntquery.h
Library Ntquery.lib
DLL Query.dll

See also

BindIFilterFromStorage

BindIFilterFromStream

IFilter