Export (0) Print
Expand All

IFilter::GetValue method

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

Syntax


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

Parameters

ppPropValue [out]

Type: PROPVARIANT**

Pointer to a variable that receives a pointer to the PROPVARIANT structure that contains the value-type property.

Return value

Type: SCODE

Return codeDescription
S_OK

Successful completion.

FILTER_E_NO_MORE_VALUES

The IFilter::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

Notes to Callers

Allocate the PROPVARIANT structure with CoTaskMemAlloc. Some PROPVARIANT structures contain pointers that can be freed by calling the PropVariantClear function, which frees all elements that can be freed in a given PROPVARIANT structure. The caller of the IFilter::GetValue method is responsible for calling the PropVariantClear method.

Notes to Implementers

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.

The IFilterSample code sample, available on Code Gallery and the Windows 7 SDK, demonstrates how to create an IFilter base class for implementing the IFilter interface.

For conceptual information about IFilter implementation, see Developing Filter Handlers. For information about IFilters and property handlers, see "Full-Text Support" and "Operating System Implementation Considerations" in Developing Property Handlers for Windows Search.

Important  

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

the Windows NT 4.0 Option Pack

Header

Filter.h

See also

Reference
CHUNKSTATE
IFilter
IFilter::GetChunk
IFilter::GetText
STAT_CHUNK
Other Resources
CoTaskMemAlloc
PROPVARIANT
PropVariantClear

 

 

Community Additions

ADD
Show:
© 2014 Microsoft