SetVolumeLabelA-Funktion (winbase.h)
Legt die Bezeichnung eines Dateisystemvolumes fest.
Syntax
BOOL SetVolumeLabelA(
[in, optional] LPCSTR lpRootPathName,
[in, optional] LPCSTR lpVolumeName
);
Parameter
[in, optional] lpRootPathName
Ein Zeiger auf eine Zeichenfolge, die den Laufwerkbuchstaben des Volumes (z. B. X:) oder den Pfad eines bereitgestellten Ordners enthält, der dem Volume zugeordnet ist (z. B. Y:\MountX). Die Zeichenfolge muss mit einem nachfolgenden umgekehrten Schrägstrich ('' enden). Wenn dieser Parameter NULL-ist, wird der Stamm des aktuellen Verzeichnisses verwendet.
[in, optional] lpVolumeName
Ein Zeiger auf eine Zeichenfolge, die die neue Beschriftung für das Volume enthält. Wenn dieser Parameter NULL-ist, löscht die Funktion alle vorhandenen Bezeichnungen aus dem angegebenen Volume und weist keine neue Bezeichnung zu.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Die maximale Länge der Volumebezeichnung beträgt 32 Zeichen.
FAT-Dateisysteme: Die maximale Volumebezeichnungslänge beträgt 11 Zeichen.
Eine Bezeichnung ist ein benutzerfreundlicher Name, den ein Benutzer einem Volume zuweist, um die Erkennung zu erleichtern. Ein Volume kann eine Beschriftung, einen Laufwerkbuchstaben, beide oder keines davon enthalten. Weitere Informationen finden Sie unter Benennen eines Volumes.
In Windows 8 und Windows Server 2012 wird diese Funktion von den folgenden Technologien unterstützt.
Technologie | Abgestützt |
---|---|
Server Message Block (SMB) 3.0-Protokoll | Nein |
SMB 3.0 Transparent Failover (TFO) | Nein |
SMB 3.0 mit Skalierungsdateifreigaben (SO) | Nein |
Freigegebenes Clustervolumedateisystem (CsvFS) | Ja |
Resilient File System (ReFS) | Ja |
SMB unterstützt keine Volumeverwaltungsfunktionen.
Anmerkung
Der winbase.h-Header definiert SetVolumeLabel als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
Anforderung | Wert |
---|---|
mindestens unterstützte Client- | Windows XP [Desktop-Apps | UWP-Apps] |
mindestens unterstützte Server- | Windows Server 2003 [Desktop-Apps | UWP-Apps] |
Zielplattform- | Fenster |
Header- | winbase.h (enthalten Windows.h) |
Library | Kernel32.lib |
DLL- | Kernel32.dll |