Fonction ScanLogContainers (clfsw32.h)

Article
08/22/2023

Énumère les conteneurs de journaux. Appelez cette fonction à plusieurs reprises pour itérer sur tous les conteneurs de journaux.

Syntaxe

CLFSUSER_API BOOL ScanLogContainers(
  [in, out]           PCLFS_SCAN_CONTEXT pcxScan,
  [in]                CLFS_SCAN_MODE     eScanMode,
  [in, out, optional] LPVOID             pReserved
);

Paramètres

[in, out] pcxScan

Pointeur vers une structure de CLFS_SCAN_CONTEXT allouée par le client que la fonction CreateLogContainerScanContext initialise.

[in] eScanMode

Mode pour les conteneurs à analyser.

Les conteneurs peuvent être analysés dans l’un des modes de CLFS_SCAN_MODE suivants.

Valeur	Signification
CLFS_SCAN_INIT	Réinitialise le contexte d’analyse, mais n’alloue pas le stockage associé. L’initialisation est destructrice, car toutes les données stockées dans le contexte d’analyse actuel sont perdues.
CLFS_SCAN_CLOSE	Annule l’initialisation du contexte d’analyse et libère le stockage système associé à un contexte d’analyse.
CLFS_SCAN_FORWARD	Entraîne le déroulement de l’appel suivant à ScanLogContainers dans une direction d’avant. Impossible d’utiliser si CLFS_SCAN_BACKWARD est spécifié.
CLFS_SCAN_BACKWARD	Entraîne l’appel suivant à ScanLogContainers dans une direction descendante. Impossible d’utiliser si CLFS_SCAN_FORWARD est spécifié.

[in, out, optional] pReserved

Réservé. Définissez pReserved sur NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

La liste suivante identifie les codes d’erreur possibles :

Remarques

L’ID d’un conteneur de journaux est retourné dans : pcxScan-pinfoContainer-LogicalContainerId>>.

Note Les contextes d’analyse CLFS (Common Log File System) ne sont pas thread-safe. Ils ne doivent pas être utilisés par plusieurs threads à la fois, ni passés dans plusieurs analyses asynchrones à la fois.

Exemples

Pour obtenir un exemple qui utilise cette fonction, consultez Énumération de conteneurs de journaux.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 R2 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	clfsw32.h
Bibliothèque	Clfsw32.lib
DLL	Clfsw32.dll