RemoveLogContainerSet, fonction (clfsw32.h)

  • Article

Supprime plusieurs conteneurs 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. La fonction RemoveLogContainer est un cas particulier de cette fonction RemoveLogContainerSet , car elle ne supprime qu’un seul conteneur. Pour supprimer plusieurs conteneurs, utilisez RemoveLogContainerSet.

Syntaxe

CLFSUSER_API BOOL RemoveLogContainerSet(
  [in]                HANDLE hLog,
  [in]                USHORT cContainer,
  [in]                LPWSTR *rgwszContainerPath,
  [in]                BOOL   fForce,
  [in, out, optional] LPVOID pReserved
);

Paramètres

[in] hLog

Handle du journal obtenu à partir de CreateLogFile.

Le handle de journal doit avoir l’autorisation d’administration pour ajouter un conteneur de journaux et peut faire référence à un journal dédié ou multiplexé.

[in] cContainer

Nombre de noms de chemins de conteneur dans un tableau pointé par rgwszContainerPath.

Cette valeur doit être différente de zéro.

[in] rgwszContainerPath

Tableau de pointeurs vers des noms de chemin de conteneur qui contiennent des pointeurs cContainers .

Chaque nom de chemin est une chaîne de caractères large qui identifie un conteneur 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é quand il ne fait plus partie de la région de journal active.

[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

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 du journal actif. Si le conteneur fait partie du journal actif, il est marqué pour suppression. Cette suppression est différée jusqu’à ce que la fin du journal dépasse le dernier secteur du conteneur, ou que le conteneur ait un identificateur logique supérieur à l’identificateur logique de la tête 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 un conteneur fait partie du journal actif, l’appel échoue sans marquer le conteneur en vue de sa suppression.

Configuration requise

   
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

RemoveLogContainer