GetLogContainerName-Funktion (clfsw32.h)
Ruft den vollständigen Pfadnamen des angegebenen Containers ab. Diese Funktion wird hauptsächlich verwendet, um den vollständigen Pfadnamen eines Containers abzurufen, auf den in der CLFS_CONTAINER_INFORMATION-Struktur verwiesen wird, der in Aufrufen von ScanLogContainers zurückgegeben wird.
Syntax
CLFSUSER_API BOOL GetLogContainerName(
[in] HANDLE hLog,
[in] CLFS_CONTAINER_ID cidLogicalContainer,
[in, out] LPCWSTR pwstrContainerName,
[in] ULONG cLenContainerName,
[in, out, optional] PULONG pcActualLenContainerName
);
Parameter
[in] hLog
Ein Handle für das Protokoll, das aus einem erfolgreichen Aufruf von CreateLogFile abgerufen wird.
Das Protokollhandle kann auf einen Protokolldatenstrom oder ein physisches Protokoll verweisen.
[in] cidLogicalContainer
Der eindeutige Bezeichner, der einem Container zugeordnet ist.
[in, out] pwstrContainerName
Ein Zeiger auf einen vom Benutzer zugewiesenen Puffer, um den vollständigen Pfad und Namen des Protokollcontainers in Breitzeichen zu empfangen.
[in] cLenContainerName
Die Größe des Puffers, auf den pwstrContainerName in Zeichen verweist.
[in, out, optional] pcActualLenContainerName
Ein Zeiger auf eine Variable, um die tatsächliche Zeichenanzahl des vollständigen Containerpfadnamens zu erhalten, der abgerufen wird.
Wenn die Funktion erfolgreich ist, ist der Wert dieses Parameters kleiner oder gleich cLenContainerName. Wenn der Puffer nicht groß genug ist, um den gesamten Containerpfadnamen zu speichern, schlägt die Funktion mit ERROR_MORE_DATA fehl und legt diesen Parameter auf die Größe fest, die für den vollständigen Pfadnamen erforderlich ist. Bei anderen Fehlern ist der Wert nicht definiert.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert 0 (null). Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. In der folgenden Liste werden die möglichen Fehlercodes identifiziert:
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows Vista [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2003 R2 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | clfsw32.h |
| Bibliothek | Clfsw32.lib |
| DLL | Clfsw32.dll |