ClfsGetContainerName, fonction (wdm.h)

Article
02/27/2024

La routine ClfsGetContainerName retourne le nom de 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 précédemment obtenu 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 membre Buffer de puszContainerName doit pointer vers une mémoire tampon allouée à 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 de type 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 retournée

ClfsGetContainerName retourne l’un des codes status définis dans Ntstatus.h. Le tableau suivant donne la signification de différentes valeurs de retour.

Code de retour	Description
STATUS_SUCCESS	Le membre Buffer de puszContainerName reçoit le nom complet du chemin d’accès du conteneur. Si pcActualLenContainerName n’a pas la valeur NULL, il reçoit la longueur réelle, en caractères Unicode, du nom complet du chemin d’accès.
STATUS_BUFFER_OVERFLOW	La longueur réelle, en caractères Unicode, du nom complet du chemin d’accès 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é par puszContainerName->MaximumLength. Si pcActualLenContainerName n’a pas la valeur NULL, il reçoit la longueur réelle, en caractères Unicode, du nom complet du chemin d’accès.
Autres	Au retour, le contenu de lamémoire tamponpuszContainerName-> et de pcActualLenContainerName n’est pas défini.

Remarques

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows Server 2003 R2, Windows Vista et versions ultérieures de Windows.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	wdm.h (include Wdm.h)
Bibliothèque	Clfs.lib
DLL	Clfs.sys
IRQL	<= APC_LEVEL

Voir aussi

ClfsAddLogContainer

ClfsRemoveLogContainer