Compartilhar via


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

Posiciona o filtro no início da próxima parte ou na primeira parte se esta 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 de retorno

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.

Observações

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

As propriedades internas de tipo de 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 do bloco zero é inválida.

Antes que o método GetChunk seja chamado pela primeira vez, não há nenhuma parte atual. Depois que um código de retorno de erro 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 for concluído, a parte descrita em * pStat é a parte atual. O descritor de partes 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 do objeto inserido.

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

Requisitos

Requisito Valor
de cliente com suporte mínimo Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino Windows
cabeçalho filter.h

Consulte também

IFilter

STAT_CHUNK