Méthode ILoadFilter ::LoadIFilter (filtereg.h)

  • Article

Récupère et charge le filtre le plus approprié mappé à une source de données Shell.

Syntaxe

HRESULT LoadIFilter(
  [in]      LPCWSTR               pwcsPath,
  [in]      FILTERED_DATA_SOURCES *pFilteredSources,
  [in]      IUnknown              *pUnkOuter,
  [in]      BOOL                  fUseDefault,
  [in, out] CLSID                 *pFilterClsid,
  [in, out] int                   *SearchDecSize,
  [in, out] WCHAR                 **pwcsSearchDesc,
  [in, out] IFilter               **ppIFilt
);

Paramètres

[in] pwcsPath

Pointeur vers une mémoire tampon de chaîne Unicode délimitée par des virgules et terminée par un caractère Null qui spécifie le chemin d’accès du fichier à filtrer. Ce paramètre peut avoir la valeur Null.

[in] pFilteredSources

Pointeur vers la structure FILTERED_DATA_SOURCES qui spécifie les paramètres d’une source de données Shell pour laquelle un filtre est chargé. Ce paramètre ne peut pas être null.

[in] pUnkOuter

Si l’objet est créé dans le cadre d’un agrégat, spécifiez un pointeur vers l’interface IUnknown de contrôle de l’agrégat.

[in] fUseDefault

Si la valeur est TRUE, utilisez le filtre par défaut ; si la valeur est FALSE, utilisez le filtre le plus approprié disponible.

[in, out] pFilterClsid

Pointeur vers le CLSID (CLSID_FilterRegistration) qui reçoit l’identificateur de classe du filtre retourné.

[in, out] SearchDecSize

Non implémenté.

[in, out] pwcsSearchDesc

Non implémenté.

[in, out] ppIFilt

Adresse d’un pointeur vers une implémentation d’une interface IFilter que LoadIFilter sélectionne.

Valeur retournée

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Un filtre, également appelé gestionnaire de filtre, est une implémentation de l’interface IFilter .

ILoadFilter tente de charger un filtre qui peut traiter une source de données Shell du type spécifié dans le paramètre pFilteredSources via le paramètre pwcsPath . Si un filtre approprié pour la source de données est introuvable et que fUseDefault a la valeur false, cette méthode retourne null dans le paramètre ppIFilt . Si un filtre approprié pour la source de données est introuvable et que fUseDefault a la valeur true, l’interface IFilter sur le IFilter par défaut est retournée dans le paramètre ppIFilt .

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête filtereg.h
Bibliothèque SearchSDK.lib (pour CLSID_FilterRegistration)

Voir aussi

ILoadFilter