RemoveLogContainer-Funktion (clfsw32.h)
Entfernt einen Container aus einem Protokoll, der einem dedizierten oder multiplexten Protokollhandle zugeordnet ist.
Ein Client muss über Administratorrechte für das Protokollhandle verfügen, um einen Container zu entfernen. Verwenden Sie zum Entfernen mehrerer Container die RemoveLogContainerSet-Funktion .
Syntax
CLFSUSER_API BOOL RemoveLogContainer(
[in] HANDLE hLog,
[in] LPWSTR pwszContainerPath,
[in] BOOL fForce,
[in, out, optional] LPVOID pReserved
);
Parameter
[in] hLog
Ein Handle für das Protokoll, das aus CreateLogFile abgerufen wird.
[in] pwszContainerPath
Ein Zeiger auf eine Breitzeichenzeichenfolge, die einen Pfad für einen Protokollcontainer enthält, der entweder von AddLogContainer oder AddLogContainerSet erstellt wird.
[in] fForce
Das Löschflag, das bestimmt, wann und wie ein Container gelöscht wird.
Wenn fForceauf TRUE festgelegt ist und der Container Teil der aktiven Protokollregion ist, wird der Container nicht gelöscht, und es wird ein Fehler ERROR_LOG_CANT_DELETE zurückgegeben.
Bei FALSE wird der Container gelöscht, wenn der Container nicht mehr Teil der aktiven Protokollregion ist.
[in, out, optional] pReserved
Dieser Parameter ist reserviert und sollte auf NULL festgelegt werden.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.
Die folgende Liste identifiziert die möglichen Fehlercodes:
Hinweise
Standardmäßig ist das Löschen von Containern verzögert, was bedeutet, dass ein Container nur gelöscht wird, wenn er nicht Teil eines aktiven Protokolls ist. Wenn der Container Teil des aktiven Protokolls ist, wird er zum Löschen markiert. Das Löschen erfolgt jedoch erst, wenn das Ende des Protokolls den letzten Sektor des Containers überschreitet oder der Container einen logischen Bezeichner aufweist, der größer als der logische Bezeichner des Hauptteils des aktiven Protokolls ist. Die Protokollgröße gibt den Löschvorgang des Containers nur dann wieder, wenn der Container physisch gelöscht wird.
Ein Protokollclient kann einen erzwungenen Löschvorgang für einen Container anfordern, indem er das Löschflag auf TRUE festlegt. Dies hat die gleiche Auswirkung wie das Löschen eines Containers, der nicht Teil des aktiven Protokolls ist. Wenn der Container jedoch Teil des aktiven Protokolls ist, schlägt der Aufruf fehl, ohne den Container zum Löschen zu markieren.
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 |