Método IMFASFIndexer::GetIndexStatus (wmcontainer.h)

Recupera as configurações de índice para um fluxo e um tipo de índice especificados.

Sintaxe

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

Parâmetros

[in] pIndexIdentifier

Ponteiro para uma estrutura ASF_INDEX_IDENTIFIER que contém o número do fluxo e o tipo de índice para o qual obter o status.

[out] pfIsIndexed

Uma variável que recupera um valor booliano que especifica se o índice descrito por pIndexIdentifier foi criado.

[out] pbIndexDescriptor

Um buffer que recebe o descritor de índice. O descritor de índice consiste em uma estrutura ASF_INDEX_DESCRIPTOR , opcionalmente seguida por dados específicos do índice.

[in, out] pcbIndexDescriptor

Na entrada, especifica o tamanho, em bytes, do buffer para o qual pbIndexDescriptor aponta. O valor poderá ser zero se pbIndexDescriptor for NULL. Na saída, recebe o tamanho do descritor de índice, em bytes.

Retornar valor

O método retorna um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Código de retorno	Descrição
S_OK	O método foi bem-sucedido.
MF_E_BUFFERTOOSMALL	O tamanho do buffer especificado em pcbIndexDescriptor é muito pequeno.

Comentários

Para ler um índice ASF existente, chame IMFASFIndexer::SetIndexByteStreams antes de chamar esse método.

Se existir um índice para o fluxo e o valor passado para pcbIndexDescriptor for menor que o tamanho necessário do buffer pbIndexDescriptor , o método retornará MF_E_BUFFERTOOSMALL. O tamanho do buffer necessário é retornado no parâmetro pcbIndexDescriptor .

Se não houver nenhum índice para o fluxo especificado, o método retornará FALSE no parâmetro pfIsIndexed .

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	wmcontainer.h
Biblioteca	Mfuuid.lib

Confira também

Objeto Index do ASF

IMFASFIndexer