Fonction RemoveLogContainer (clfsw32.h)

  • Article

Supprime un conteneur d’un journal associé à un handle de journal dédié ou multiplexé.

Un client doit disposer de privilèges d’administration sur le handle de journal pour supprimer un conteneur. Pour supprimer plusieurs conteneurs, utilisez la fonction RemoveLogContainerSet .

Syntaxe

CLFSUSER_API BOOL RemoveLogContainer(
  [in]                HANDLE hLog,
  [in]                LPWSTR pwszContainerPath,
  [in]                BOOL   fForce,
  [in, out, optional] LPVOID pReserved
);

Paramètres

[in] hLog

Handle du journal obtenu à partir de CreateLogFile.

[in] pwszContainerPath

Pointeur vers une chaîne de caractères large qui contient un chemin d’accès pour un conteneur de journaux créé par AddLogContainer ou AddLogContainerSet.

[in] fForce

Indicateur de suppression qui détermine quand et comment un conteneur est supprimé.

Si fForce a la valeur TRUE et que le conteneur fait partie de la région de journal active, le conteneur n’est pas supprimé et une erreur ERROR_LOG_CANT_DELETE est retournée.

Si la valeur est FALSE, le conteneur est supprimé lorsque le conteneur ne fait plus partie de la région de journal active.

[in, out, optional] pReserved

Ce paramètre est réservé et doit être défini 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

Par défaut, la suppression de conteneur est différée, ce qui signifie qu’un conteneur est supprimé uniquement s’il ne fait pas partie d’un journal actif. Si le conteneur fait partie du journal actif, il est marqué pour suppression. Toutefois, la suppression ne se produit pas tant que la fin du journal ne dépasse pas le dernier secteur du conteneur, ou que le conteneur a un identificateur logique supérieur à l’identificateur logique du chef du journal actif. La taille du journal reflète la suppression du conteneur uniquement lorsque le conteneur est supprimé physiquement.

Un client de journal peut demander une suppression forcée sur un conteneur en définissant l’indicateur de suppression sur TRUE. Cela a le même effet que la suppression d’un conteneur qui ne fait pas partie du journal actif. Toutefois, si le conteneur fait partie du journal actif, l’appel échoue sans marquer le conteneur en vue de sa suppression.

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

Voir aussi

AddLogContainer

AddLogContainerSet

Fonctions courantes du système de fichiers journaux

OVERLAPPED

RemoveLogContainerSet