Fonction ClfsDeleteLogFile (wdm.h)

La routine ClfsDeleteLogFile marque un flux CLFS à supprimer.

Syntaxe

CLFSUSER_API NTSTATUS ClfsDeleteLogFile(
  [in]           PUNICODE_STRING puszLogFileName,
                 PVOID           pvReserved,
  [in]           ULONG           fLogOptionFlag,
  [in, optional] PVOID           pvContext,
  [in]           ULONG           cbContext
);

Paramètres

[in] puszLogFileName

Pointeur vers une structure de UNICODE_STRING qui fournit le nom du flux CLFS à supprimer.

Si le flux à supprimer est le seul flux d’un journal dédié, le nom a la forme log :nom du journal physique, où nom du journal physique est le nom du chemin d’accès du journal physique sur le système de fichiers sous-jacent.

Si le flux à supprimer est l’un des flux d’un journal multiplexé, le nom a la forme log :physical log name ::stream, où nom du journal physique est le nom du chemin d’accès du journal physique sur le système de fichiers sous-jacent et nom du flux est le nom unique du flux à supprimer.

pvReserved

Réservé.

[in] fLogOptionFlag

Valeur qui indique la relation entre CLFS et le composant qui supprime le journal. Pour obtenir la liste des valeurs possibles, consultez la description du paramètre fLogOptionFlag de la routine ClfsCreateLogFile .

[in, optional] pvContext

Pointeur vers un contexte. La façon dont le contexte est interprété dépend de la valeur transmise dans fLogOptionFlag.

[in] cbContext

Taille, en octets, du contexte pointé par pvContext. Si pvContext n’a pas la valeur NULL, ce paramètre doit être supérieur à zéro.

Valeur retournée

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

Remarques

Le système CLFS (Common Log File System) utilise la structure LOG_FILE_OBJECT pour représenter les journaux. La fonction ClfsCreateLogFile retourne un pointeur vers LOG_FILE_OBJECT, que les clients passent ensuite à d’autres fonctions CLFS.

Les clients CLFS n’accèdent pas directement aux membres d’une structure de LOG_FILE_OBJECT. Pour plus d’informations sur les membres, consultez FILE_OBJECT.

ClfsDeleteLogFile marque un flux de suppression, mais ne ferme pas les objets de fichier journal actuellement ouverts. Pour fermer un objet de fichier journal, appelez ClfsCloseLogFileObject. Un flux marqué pour suppression est supprimé une fois que tous les objets de fichier journal associés au flux sont fermés.

Un flux CLFS marqué pour suppression refuse les demandes suivantes d’ouverture du flux.

Le nom d’un journal CLFS physique n’inclut pas l’extension .blf.

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

Configuration requise

Voir aussi

ClfsCloseAndResetLogFile

ClfsCloseLogFileObject

ClfsCreateLogFile

ClfsDeleteLogByPointer