Export (0) Print
Expand All
1 out of 2 rated this helpful - Rate this topic

IFilter::GetValue method

[Indexing Service is no longer supported as of Windows XP and is unavailable for use as of Windows 8. Instead, use Windows Search for client side search and Microsoft Search Server Express for server side search.]

Retrieves a value (internal value-type property) from a chunk, which must have a CHUNKSTATE enumeration value of CHUNK_VALUE.

Syntax


HRESULT GetValue(
  [out]  PROPVARIANT **ppPropValue
);

Parameters

ppPropValue [out]

A pointer to an output variable that receives a pointer to the PROPVARIANT structure that contains the value-type property.

Return value

This method can return one of these values.

Return codeDescription
S_OK

The operation was completed successfully.

FILTER_E_NO_MORE_VALUES

The GetValue method has already been called on this chunk; this value should be returned until the IFilter::GetChunk method has been called successfully and has advanced to the next chunk.

FILTER_E_NO_VALUES

The current chunk does not have a CHUNKSTATE enumeration value of CHUNK_VALUE.

 

Remarks

Call the GetValue method only once per chunk.

Note that the effect of producing the same value from more than one chunk is undefined. Only the last setting of the value is valid.

Notes to Callers

Allocate the PROPVARIANT structure with CoTaskMemAlloc. Some PROPVARIANT structures contain pointers, which can be freed by calling the PropVariantClear function. It is up to the caller of the GetValue method to call PropVariantClear.

Requirements

Minimum supported client

Windows 2000 Professional (desktop apps only)

Minimum supported server

Windows 2000 Server (desktop apps only)

End of client support

Windows 7

End of server support

Windows Server 2008 R2

Header

Filter.h

See also

IFilter

 

 

Build date: 9/10/2012

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.