GetLogContainerName, fonction (clfsw32.h)

  • Article

Récupère le nom complet du chemin d’accès du conteneur spécifié. Cette fonction est principalement utilisée pour obtenir le nom de chemin d’accès complet d’un conteneur référencé dans la structure CLFS_CONTAINER_INFORMATION qui est retournée dans les appels à ScanLogContainers.

Syntaxe

CLFSUSER_API BOOL GetLogContainerName(
  [in]                HANDLE            hLog,
  [in]                CLFS_CONTAINER_ID cidLogicalContainer,
  [in, out]           LPCWSTR           pwstrContainerName,
  [in]                ULONG             cLenContainerName,
  [in, out, optional] PULONG            pcActualLenContainerName
);

Paramètres

[in] hLog

Handle du journal obtenu à partir d’un appel réussi à CreateLogFile.

Le handle de journal peut faire référence à un flux de journal ou à un journal physique.

[in] cidLogicalContainer

Identificateur unique associé à un conteneur.

[in, out] pwstrContainerName

Pointeur vers une mémoire tampon allouée par l’utilisateur pour recevoir le chemin complet et le nom du conteneur de journaux, en caractères larges.

[in] cLenContainerName

Taille de la mémoire tampon pointée vers pwstrContainerName, en caractères.

[in, out, optional] pcActualLenContainerName

Pointeur vers une variable pour recevoir le nombre de caractères réel du nom de chemin de conteneur complet récupéré.

Si la fonction réussit, la valeur de ce paramètre est inférieure ou égale à cLenContainerName. Si la mémoire tampon n’est pas assez grande pour stocker l’intégralité du nom du chemin d’accès du conteneur, la fonction échoue avec ERROR_MORE_DATA et définit ce paramètre à la taille requise pour le nom complet du chemin d’accès. Pour les autres échecs, la valeur n’est pas définie.

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 (0). Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. La liste suivante identifie les codes d’erreur possibles :

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

CLFS_CONTAINER_INFORMATION

Fonctions courantes du système de fichiers journaux

ScanLogContainers