BindIFilterFromStream 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 the IFilter interface pointer for the specified storage object. This is especially useful when filtering the contents of a document and processing embedded OLE objects accessible through their IStream interfaces.

Syntax

HRESULT BindIFilterFromStream(
  [in]  IStream  *pStm,
  [in]  IUnknown *pUnkOuter,
  [out] void     **ppIUnk
);

Parameters

[in] pStm

A pointer to the IStream interface to be used to access the file.

[in] pUnkOuter

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

[out] ppIUnk

A pointer to an output 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 path of the storage object.
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.

Remarks

This function is not a full implementation of a COM persistent handler.

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 Ntquery.dll

See also

BindIFilterFromStorage

IFilter

LoadIFilter