Método IFilter::GetChunk (filter.h)

Observação

O Serviço de Indexação não tem mais suporte a partir do Windows XP e não está disponível para uso a partir do Windows 8. Em vez disso, use a pesquisa do lado do cliente da Pesquisa do Windows e o Microsoft Search Server Express para pesquisa no lado do servidor.

Posiciona o filtro no início da próxima parte ou na primeira parte se essa for a primeira chamada para o método GetChunk e retornará uma descrição da parte atual.

Sintaxe

SCODE GetChunk(
  [out] STAT_CHUNK *pStat
);

Parâmetros

[out] pStat

Um ponteiro para uma estrutura STAT_CHUNK que contém uma descrição da parte atual.

Valor retornado

Esse método pode retornar um desses valores.

Código de retorno	Descrição
S_OK	A operação foi concluída com êxito.
FILTER_E_END_OF_CHUNKS	A parte anterior é a última parte.
FILTER_E_EMBEDDING_UNAVAILABLE	A próxima parte é uma inserção e nenhum filtro de conteúdo está disponível.
FILTER_E_LINK_UNAVAILABLE	A próxima parte é um link e nenhum filtro de conteúdo está disponível.
FILTER_E_PASSWORD	Senha ou outra falha de acesso relacionada à segurança.
FILTER_E_ACCESS	Falha de acesso geral.

Comentários

Se ao retornar pStat apontar para uma estrutura STAT_CHUNK com o membro breakType igual a CHUNK_NO_BREAK, somente o membro idChunk será atualizado com o novo valor de ID (identificador de parte). Os outros membros da estrutura STAT_CHUNK permanecem inalterados.

As propriedades internas do tipo valor (partes com um valor de enumeração CHUNKSTATE de CHUNK_VALUE) não podem ser concatenadas usando CHUNK_NO_BREAK. Uma única palavra não pode abranger mais de duas partes coladas.

A ID da parte zero é inválida.

Antes que o método GetChunk seja chamado pela primeira vez, não há nenhuma parte atual. Após um erro retornar o código de qualquer coisa diferente de FILTER_E_END_OF_CHUNKS a próxima chamada para o método GetChunk , no entanto, recupera a próxima parte após a indisponível.

Anotações para chamadores

Quando o método GetChunk é concluído, a parte descrita em *pStat é a parte atual. O descritor de parte pertence à rotina que chama o método GetChunk , mas o ponteiro do nome da propriedade, que pode ser definido na especificação da propriedade, pertence ao método GetChunk e não deve ser liberado.

Anotações aos implementadores

Se uma chamada para o método GetChunk do filtro de conteúdo de um objeto vinculado ou inserido retornar FILTER_E_END_OF_CHUNKS, a implementação deverá retornar a próxima parte do objeto de vinculação ou inserção. Por exemplo, se um documento tiver dois objetos inseridos e o primeiro tiver retornado FILTER_E_END_OF_CHUNKS, o filtro de conteúdo externo deverá chamar o método GetChunk do filtro de conteúdo para o objeto inserido.

Antes de retornar os resultados de uma chamada para o método GetChunk em um objeto inserido ou vinculado, marcar para garantir que a ID da parte seja exclusiva. Caso contrário, o implementador deve renumerar a parte e manter um mapeamento da nova ID da parte.

Requisitos

Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	filter.h

Confira também

Ifilter

STAT_CHUNK