Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IMFASFIndexer::SetIndexStatus method

Configures the index for a stream.

Syntax


HRESULT SetIndexStatus(
  [in]  BYTE *pIndexDescriptor,
  [in]  DWORD cbIndexDescriptor,
  [in]  BOOL fGenerateIndex
);

Parameters

pIndexDescriptor [in]

The index descriptor to set. The index descriptor is an ASF_INDEX_DESCRIPTOR structure, optionally followed by index-specific data.

cbIndexDescriptor [in]

The size, in bytes, of the index descriptor.

fGenerateIndex [in]

A Boolean value. Set to TRUE to have the indexer create an index of the type specified for the stream specified in the index descriptor.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

MF_E_INVALIDREQUEST

At attempt was made to change the index status in a seek-only scenario. For more information, see Remarks.

 

Remarks

You must make all calls to SetIndexStatus before making any calls to IMFASFIndexer::GenerateIndexEntries.

The indexer object is configured to create temporal indexes for each stream by default. Call this method only if you want to override the default settings.

You cannot use this method in an index reading scenario. You can only use this method when writing indexes.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Wmcontainer.h

Library

Mfuuid.lib

See also

IMFASFIndexer
ASF Index Object

 

 

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.