SHGetDiskFreeSpaceExA-Funktion (shellapi.h)

  • Artikel

Ruft Informationen zum Speicherplatz für ein Datenträgervolume ab.

Syntax

BOOL SHGetDiskFreeSpaceExA(
  [in]            LPCSTR         pszDirectoryName,
  [out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);

Parameter

[in] pszDirectoryName

Typ: LPCTSTR

Eine NULL-endende Zeichenfolge, die das Volume angibt, für das Größeninformationen abgerufen werden. Dies kann ein Laufwerkbuchstabe, ein UNC-Name oder der Pfad eines Ordners sein. Sie können NULL nicht verwenden, um das aktuelle Laufwerk darzustellen.

[out, optional] pulFreeBytesAvailableToCaller

Typ: ULARGE_INTEGER*

Zeiger auf einen Wert, der die Anzahl der Bytes auf dem Volume empfängt, das für die aufrufende Anwendung verfügbar ist. Wenn das Betriebssystem Kontingente pro Benutzer implementiert, kann dieser Wert kleiner als die Gesamtzahl der freien Bytes auf dem Volume sein.

[out, optional] pulTotalNumberOfBytes

Typ: ULARGE_INTEGER*

Zeiger auf einen Wert, der die Gesamtgröße des Volumes in Bytes empfängt.

[out, optional] pulTotalNumberOfFreeBytes

Typ: ULARGE_INTEGER*

Zeiger auf einen Wert, der die Anzahl der Bytes des freien Speicherplatzes auf dem Volume empfängt.

Rückgabewert

Typ: BOOL

Gibt TRUE zurück, wenn erfolgreich, andernfalls FALSE .

Hinweise

Die ähnlich benannte Funktion SHGetDiskFreeSpace ist lediglich ein Alias für SHGetDiskFreeSpaceEx. Wenn Sie SHGetDiskFreeSpace aufrufen, rufen Sie diese Funktion tatsächlich auf.

Diese Funktion ruft die GetDiskFreeSpaceEx-Funktion auf, wenn sie auf dem Betriebssystem verfügbar ist. Wenn GetDiskFreeSpaceEx nicht verfügbar ist, wird es emuliert, indem die GetDiskFreeSpace-Funktion aufgerufen und die Rückgabewerte bearbeitet werden. Weitere Informationen finden Sie in der Dokumentation zu GetDiskFreeSpaceEx.

Hinweis

Der Shellapi.h-Header definiert SHGetDiskFreeSpaceEx 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

   
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shellapi.h
Bibliothek Shell32.lib
DLL Shell32.dll (Version 5.0 oder höher)

Weitere Informationen

GetDiskFreeSpaceEx

SHGetDiskFreeSpace