ClfsScanLogContainers, fonction (wdm.h)

La routine ClfsScanLogContainers récupère des informations descriptives pour une séquence de conteneurs qui appartiennent à un journal CLFS particulier.

Syntaxe

CLFSUSER_API NTSTATUS ClfsScanLogContainers(
  [in, out] PCLFS_SCAN_CONTEXT pcxScan,
  [in]      CLFS_SCAN_MODE     eScanMode
);

Paramètres

[in, out] pcxScan

Pointeur vers une structure CLFS_SCAN_CONTEXT . L’appelant a précédemment alloué la structure et l’a initialisée en appelant ClfsCreateScanContext. En particulier, le membre pInfoContainer a été initialisé pour pointer vers un tableau de structures CLFS_CONTAINER_INFORMATION , et le membre cContainers a été initialisé au nombre d’éléments dans le tableau. Au retour, les structures du tableau reçoivent des informations descriptives pour les conteneurs dans la séquence.

[in] eScanMode

Ensemble d’indicateurs qui spécifient la direction de l’analyse et si le contexte d’analyse doit être fermé. Les indicateurs suivants sont disponibles pour les appelants de cette routine.

Valeur Signification
CLFS_SCAN_FORWARD Analysez dans la direction vers l’avant. Par exemple, si le conteneur 5 est le conteneur le plus récemment analysé et que pxcScan->cContainers est égal à deux, cette routine retourne des descripteurs pour les conteneurs 6 et 7.
CLFS_SCAN_BACKWARD Analyse dans la direction vers l’arrière. Par exemple, si le conteneur 5 est le conteneur le plus récemment analysé et que pxcScan->cContainers est égal à deux, cette routine retourne des descripteurs pour les conteneurs 4 et 3.
CLFS_SCAN_CLOSE Libérez toutes les ressources associées au contexte d’analyse pointé par pcxScan.
 

Si l’indicateur CLFS_SCAN_CLOSE est défini, les indicateurs CLFS_SCAN_FORWARD et CLFS_SCAN_BACKWARD doivent être clairs.

Si l’indicateur CLFS_SCAN_CLOSE est clair, un seul des indicateurs de direction (CLFS_SCAN_FORWARD ou CLFS_SCAN_BACKWARD) doit être défini.

Valeur retournée

ClfsScanLogContainers retourne STATUS_SUCCESS si elle réussit ; sinon, elle retourne l’un des codes d’erreur définis dans Ntstatus.h.

Remarques

CLFS utilise la structure CLFS_SCAN_CONTEXT pour suivre l’emplacement de démarrage d’une analyse de conteneur (le membre cIndex ) et le nombre de conteneurs analysés dans chaque appel à ClfsScanLogContainers. La valeur N du membre cContainers spécifie que chaque fois que ClfsScanLogContainers est appelé, les N conteneurs suivants sont analysés.

Le membre cContainersReturned de la structure CLFS_SCAN_CONTEXT reçoit le nombre de conteneurs réellement analysés en un seul appel à ClfsScanLogContainers.

Lorsque ClfsScanLogContainers retourne STATUS_NO_MORE_ENTRIES, il n’y a plus de conteneurs à analyser.

Une fois que vous avez terminé d’utiliser le contexte d’analyse pointé par pcxScan, vous devez appeler ClfsScanLogContainers, avec eScanMode égal à CLFS_SCAN_CLOSE, pour libérer toutes les ressources associées au contexte d’analyse.

Pour obtenir une explication des concepts et de la terminologie CLFS, consultez Common Log File System.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Disponible dans Windows Server 2003 R2, Windows Vista et versions ultérieures de Windows.
Plateforme cible Desktop (Expérience utilisateur)
En-tête wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Bibliothèque Clfs.lib
DLL Clfs.sys
IRQL <= APC_LEVEL

Voir aussi

CLFS_CONTAINER_INFORMATION

CLFS_SCAN_CONTEXT

ClfsCreateScanContext