Fonction ClfsCreateScanContext (wdm.h)

Article
02/27/2024

La routine ClfsCreateScanContext crée un contexte d’analyse qui peut être utilisé pour itérer sur les conteneurs d’un journal CLFS spécifié.

Syntaxe

CLFSUSER_API NTSTATUS ClfsCreateScanContext(
  [in]      PLOG_FILE_OBJECT   plfoLog,
  [in]      ULONG              cFromContainer,
  [in]      ULONG              cContainers,
  [in]      CLFS_SCAN_MODE     eScanMode,
  [in, out] PCLFS_SCAN_CONTEXT pcxScan
);

Paramètres

[in] plfoLog

Pointeur vers une structure LOG_FILE_OBJECT qui représente un flux CLFS. Le contexte d’analyse est créé pour le journal qui fournit le stockage sous-jacent pour ce flux. L’appelant a précédemment obtenu ce pointeur en appelant ClfsCreateLogFile.

[in] cFromContainer

Index du premier conteneur à analyser. Les conteneurs sont indexés à partir de zéro.

[in] cContainers

Nombre de conteneurs à analyser avec chaque appel à ClfsScanLogContainers.

[in] eScanMode

Ensemble d’indicateurs qui spécifient si le contexte d’analyse est configuré pour l’analyse vers l’avant ou vers l’arrière et si le contexte d’analyse doit être réinitialisé. Les trois indicateurs suivants sont disponibles pour les appelants de cette routine.

Valeur	Signification
CLFS_SCAN_FORWARD	Configurez le contexte d’analyse pour l’analyse dans la direction avant. Par exemple, si le conteneur 5 est le conteneur le plus récemment analysé et que cContainers a la valeur 2, une analyse avant renvoie des descripteurs pour les conteneurs 6 et 7.
CLFS_SCAN_BACKWARD	Configurez le contexte d’analyse pour l’analyse dans le sens inverse. Par exemple, si le conteneur 5 est le conteneur le plus récemment analysé et que cContainers a la valeur 2, une analyse descendante renvoie des descripteurs pour les conteneurs 4 et 3.
CLFS_SCAN_INIT	Réinitialisez le contexte d’analyse. La prochaine fois que ClfsScanLogContainers sera appelé, il se comportera comme s’il était appelé pour la première fois après la création du contexte d’analyse.

Si pcxScan pointe vers une structure CLFS_SCAN_CONTEXT qui est passée à cette routine pour la première fois, l’un des indicateurs de direction (CLFS_SCAN_FORWARD ou CLFS_SCAN_BACKWARD) doit être défini. L’indicateur CLFS_SCAN_INIT ne doit pas être défini.

Si pcxScan pointe vers une structure CLFS_SCAN_CONTEXT qui a été passée à cette routine précédemment, l’indicateur CLFS_SCAN_INIT doit être défini. En outre, un et un seul des indicateurs de direction (CLFS_SCAN_FORWARD ou CLFS_SCAN_BACKWARD) doivent être définis.

[in, out] pcxScan

Pointeur vers une structure de CLFS_SCAN_CONTEXT allouée par l’appelant dont les membres sont initialisés par cette routine. Cette structure est ensuite passée à ClfsScanLogContainers.

Valeur retournée

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

Remarques

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 (inclure Wdm.h)
Bibliothèque	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

Voir aussi

ClfsScanLogContainers