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

Notes

Le service d’indexation n’est plus pris en charge à partir de Windows XP et n’est pas disponible à partir de Windows 8. Utilisez plutôt Windows Search pour la recherche côté client et Microsoft Search Server Express pour la recherche côté serveur.

Positionne le filtre au début du bloc suivant, ou au premier bloc s’il s’agit du premier appel à la méthode GetChunk , puis retourne une description du bloc actuel.

Syntaxe

SCODE GetChunk(
  [out] STAT_CHUNK *pStat
);

Paramètres

[out] pStat

Pointeur vers une structure STAT_CHUNK contenant une description du bloc actuel.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	L’opération a été effectuée avec succès.
FILTER_E_END_OF_CHUNKS	Le bloc précédent est le dernier bloc.
FILTER_E_EMBEDDING_UNAVAILABLE	Le bloc suivant est un incorporation et aucun filtre de contenu n’est disponible.
FILTER_E_LINK_UNAVAILABLE	Le bloc suivant est un lien et aucun filtre de contenu n’est disponible.
FILTER_E_PASSWORD	Mot de passe ou autre échec d’accès lié à la sécurité.
FILTER_E_ACCESS	Échec d’accès général.

Notes

Si lors du retour de pStat pointe vers une structure STAT_CHUNK avec le membre breakType égal à CHUNK_NO_BREAK, seul le membre idChunk est mis à jour avec la nouvelle valeur d’identificateur de bloc (ID). Les autres membres de la structure STAT_CHUNK restent inchangés.

Les propriétés de type valeur internes (blocs avec une valeur d’énumération CHUNKSTATE de CHUNK_VALUE) ne peuvent pas être concaténées à l’aide de CHUNK_NO_BREAK. Un seul mot ne peut pas s’étendre sur plus de deux blocs collés.

L’ID de bloc zéro n’est pas valide.

Avant que la méthode GetChunk ne soit appelée pour la première fois, il n’existe aucun bloc actuel. Après une erreur, le code de retour de quelque chose d’autre que FILTER_E_END_OF_CHUNKS l’appel suivant à la méthode GetChunk récupère néanmoins le bloc suivant après l’indisponible.

Remarques aux appelants

Une fois la méthode GetChunk terminée, le bloc décrit dans *pStat est le bloc actuel. Le descripteur de bloc appartient à la routine appelant la méthode GetChunk , mais le pointeur de nom de propriété, qui peut être défini dans la spécification de propriété, appartient à la méthode GetChunk et ne doit pas être libéré.

Remarques aux implémenteurs

Si un appel à la méthode GetChunk du filtre de contenu d’un objet lié ou incorporé retourne FILTER_E_END_OF_CHUNKS, l’implémentation doit retourner le segment suivant de l’objet de liaison ou d’incorporation. Par exemple, si un document a deux objets incorporés et que le premier a retourné FILTER_E_END_OF_CHUNKS, le filtre de contenu externe doit appeler la méthode GetChunk du filtre de contenu pour l’objet incorporé.

Avant de retourner les résultats d’un appel à la méthode GetChunk sur un objet incorporé ou lié, case activée pour vous assurer que l’ID de bloc est unique. Si ce n’est pas le cas, l’implémenteur doit renuméroter le bloc et conserver un mappage du nouvel ID de bloc.

Spécifications

Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	filter.h

Voir aussi

Ifilter

STAT_CHUNK