IFilter::BindRegion Method
Retrieves an interface representing the specified portion of the object. Currently reserved for future use.
Syntax
SCODE BindRegion( FILTERREGION origPos, REFIID riid, void **ppunk );
Parameters
- origPos
[in] Specifies a FILTERREGION structure that contains the position of the text.- riid
[in] Reference to requested interface ID.- ppunk
[out] Pointer to an output variable that receives the interface pointer requested in riid. Upon successful return, *ppunk contains the requested interface pointer.
Return Value
Returns one of the following values.
S_OK Successful completion. E_NOTIMPL Currently not implemented. FILTER_W_REGION_CLIPPED The filter couldn't bind the entire region.
Remarks
If it is impossible for the BindRegion method to bind an interface to the specified region, return FILTER_W_REGION_CLIPPED. This situation can occur when the next such chunk is in a linked object or an embedded object.
Not all filters are capable of supporting the IFilter::BindRegion method in a rational way. Filters that are implemented by viewing applications will benefit the most from this method. The method is intended to be a way to pass cookies through the search engine and back to the IFilter interface implementation.
Notes to Implementers
This method is currently reserved for future use. Always return E_NOTIMPL.
See Also