ClfsGetContainerName, fonction (wdm.h)

Article
02/07/2025

La routine ClfsGetContainerName retourne le nom du chemin d’accès d’un conteneur spécifié.

Syntaxe

CLFSUSER_API NTSTATUS ClfsGetContainerName(
  [in]            PLOG_FILE_OBJECT  plfoLog,
  [in]            CLFS_CONTAINER_ID cidLogicalContainer,
  [out]           PUNICODE_STRING   puszContainerName,
  [out, optional] PULONG            pcActualLenContainerName
);

Paramètres

[in] plfoLog

Pointeur vers une structure LOG_FILE_OBJECT qui représente un journal CLFS. L’appelant a obtenu précédemment ce pointeur en appelant ClfsCreateLogFile.

[in] cidLogicalContainer

Identificateur logique d’un conteneur dans le journal CLFS.

[out] puszContainerName

Pointeur vers une structure UNICODE_STRING. Le Buffer membre de puszContainerName doit pointer vers une mémoire tampon allouée par l’appelant qui reçoit le nom du chemin d’accès du conteneur. Le membre MaximumLength doit fournir la taille de la mémoire tampon.

[out, optional] pcActualLenContainerName

Pointeur vers une variable typée ULONG qui reçoit la longueur réelle, en caractères Unicode, du nom du chemin d’accès du conteneur. Ce paramètre peut être NULL.

Valeur de retour

ClfsGetContainerName retourne l’un des codes d’état définis dans Ntstatus.h. Le tableau suivant donne les significations des différentes valeurs de retour.

Retourner le code	Description
STATUS_SUCCESS	Le Buffer membre de puszContainerName reçoit le nom complet du chemin d’accès du conteneur. Si pcActualLenContainerName n’est pas NULL, il reçoit la longueur réelle, en caractères Unicode, du nom du chemin d’accès complet.
STATUS_BUFFER_OVERFLOW	La longueur réelle, en caractères Unicode, du nom du chemin d’accès complet est supérieure à puszContainerName->MaximumLength. Le membre buffer de puszContainerName reçoit le nom complet du chemin d’accès du conteneur tronqué au nombre de caractères spécifiés par puszContainerName->MaximumLength. Si pcActualLenContainerName n’est pas NULL, il reçoit la longueur réelle, en caractères Unicode, du nom du chemin d’accès complet.
autres	Lors du retour, le contenu de puszContainerName->buffer et pcActualLenContainerName ne sont pas définis.

Remarques

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

Exigences

Exigence	Valeur
client minimum pris en charge	Disponible dans Windows Server 2003 R2, Windows Vista et versions ultérieures de Windows.
plateforme cible	Bureau
d’en-tête	wdm.h (include Wdm.h)
bibliothèque	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

Voir aussi

ClfsAddLogContainer

ClfsRemoveLogContainer

Partager via