ClfsGetContainerName-Funktion (wdm.h)

  • Artikel

Die ClfsGetContainerName-Routine gibt den Pfadnamen eines angegebenen Containers zurück.

Syntax

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

Parameter

[in] plfoLog

Ein Zeiger auf eine LOG_FILE_OBJECT-Struktur , die ein CLFS-Protokoll darstellt. Der Aufrufer hat diesen Zeiger zuvor durch Aufrufen von ClfsCreateLogFile abgerufen.

[in] cidLogicalContainer

Der logische Bezeichner eines Containers im CLFS-Protokoll.

[out] puszContainerName

Ein Zeiger auf eine UNICODE_STRING-Struktur . Der Buffer-Member von puszContainerName muss auf einen vom Aufrufer zugewiesenen Puffer verweisen, der den Pfadnamen des Containers empfängt. Der MaximumLength-Member muss die Größe des Puffers angeben.

[out, optional] pcActualLenContainerName

Ein Zeiger auf eine Variable vom Typ ULONG, die die tatsächliche Länge des Pfadnamens des Containers in Unicode-Zeichen empfängt. Dieser Parameter kann NULL sein.

Rückgabewert

ClfsGetContainerName gibt einen der in Ntstatus.h definierten status Codes zurück. Die folgende Tabelle enthält die Bedeutung verschiedener Rückgabewerte.

Rückgabecode Beschreibung
STATUS_SUCCESS
 Der Buffer-Member von puszContainerName empfängt den vollständigen Pfadnamen des Containers. Wenn pcActualLenContainerName nicht NULL ist, empfängt es die tatsächliche Länge des vollständigen Pfadnamens in Unicode-Zeichen.
STATUS_BUFFER_OVERFLOW
 Die tatsächliche Länge des vollständigen Pfadnamens in Unicode-Zeichen ist größer als puszContainerName->MaximumLength. Der Buffer-Member von puszContainerName empfängt den vollständigen Pfadnamen des Containers, der auf die Anzahl der Zeichen gekürzt wird, die durch puszContainerName->MaximumLength angegeben sind. Wenn pcActualLenContainerName nicht NULL ist, empfängt es die tatsächliche Länge des vollständigen Pfadnamens in Unicode-Zeichen.
Andere
 Bei der Rückgabe sind der Inhalt von puszContainerName->Buffer und pcActualLenContainerName nicht definiert.

Hinweise

Eine Erläuterung der CLFS-Konzepte und -Terminologie finden Sie unter Common Log File System( Common Log File System).

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Verfügbar in Windows Server 2003 R2, Windows Vista und höheren Versionen von Windows.
Zielplattform Desktop
Kopfzeile wdm.h (wdm.h einschließen)
Bibliothek Clfs.lib
DLL Clfs.sys
IRQL <= APC_LEVEL

Weitere Informationen

ClfsAddLogContainer

ClfsRemoveLogContainer