IMFASFIndexer::GetIndexStatus method (wmcontainer.h)

Retrieves the index settings for a specified stream and index type.

Syntax

HRESULT GetIndexStatus(
  [in]      ASF_INDEX_IDENTIFIER *pIndexIdentifier,
  [out]     BOOL                 *pfIsIndexed,
  [out]     BYTE                 *pbIndexDescriptor,
  [in, out] DWORD                *pcbIndexDescriptor
);

Parameters

[in] pIndexIdentifier

Pointer to an ASF_INDEX_IDENTIFIER structure that contains the stream number and index type for which to get the status.

[out] pfIsIndexed

A variable that retrieves a Boolean value specifying whether the index described by pIndexIdentifier has been created.

[out] pbIndexDescriptor

A buffer that receives the index descriptor. The index descriptor consists of an ASF_INDEX_DESCRIPTOR structure, optionally followed by index-specific data.

[in, out] pcbIndexDescriptor

On input, specifies the size, in bytes, of the buffer that pbIndexDescriptor points to. The value can be zero if pbIndexDescriptor is NULL. On output, receives the size of the index descriptor, in bytes.

Return value

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

Return code	Description
S_OK	The method succeeded.
MF_E_BUFFERTOOSMALL	The buffer size specified in pcbIndexDescriptor is too small.

Remarks

To read an existing ASF index, call IMFASFIndexer::SetIndexByteStreams before calling this method.

If an index exists for the stream and the value passed into pcbIndexDescriptor is smaller than the required size of the pbIndexDescriptor buffer, the method returns MF_E_BUFFERTOOSMALL. The required buffer size is returned in the pcbIndexDescriptor parameter.

If there is no index for the specified stream, the method returns FALSE in the pfIsIndexed parameter.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	wmcontainer.h
Library	Mfuuid.lib

See also

ASF Index Object

IMFASFIndexer