WofIsExternalFile-Funktion (wofapi.h)

  • Artikel

Wird verwendet, um zu bestimmen, ob einer Datei eine physische Datei oder ein Systemdatenanbieter zugrunde liegt, und gibt optional den Anbieter oder zusätzlichen Daten zu der Datei an.

Syntax

HRESULT WofIsExternalFile(
  [in]                LPCWSTR FilePath,
  [out, optional]     PBOOL   IsExternalFile,
  [out, optional]     PULONG  Provider,
  [out, optional]     PVOID   ExternalFileInfo,
  [in, out, optional] PULONG  BufferLength
);

Parameter

[in] FilePath

Gibt den Pfad zu der Datei an, für die der Sicherungszustand gewünscht ist.

[out, optional] IsExternalFile

Zeigt optional auf einen BOOL-Wert. Bei erfolgreicher Rückgabe ist dieser Wert TRUE, wenn das Objekt extern gesichert wird, FALSE, wenn es sich um eine physische Datei handelt.

[out, optional] Provider

Zeigt optional auf einen ULONG-Wert. Bei erfolgreicher Rückgabe wird dieser Wert auf den Anbieter festgelegt, der dieses Objekt extern unterstützt. Derzeit definierte Anbieter sind:

WOF_PROVIDER_WIM Gibt an, dass sich die Daten für die Datei in einer separaten WIM-Datei befinden. Beim Zugriff werden Daten transparent extrahiert, dekomprimiert und Anwendungen zur Verfügung gestellt. Wenn der Dateiinhalt geändert wird, werden die Daten transparent dekomprimiert, und die Datei wird in eine reguläre Datei wiederhergestellt.
WOF_PROVIDER_FILE Gibt an, dass die Daten für die Datei komprimiert und mit der Datei selbst gespeichert werden sollen. Beim Zugriff werden Daten transparent dekomprimiert und anwendungen zur Verfügung gestellt. Wenn der Dateiinhalt geändert wird, werden die Daten transparent dekomprimiert, und die Datei wird in eine reguläre Datei wiederhergestellt. Dieser Anbieter erfordert Windows 10.

[out, optional] ExternalFileInfo

Zeigt optional auf einen vom Aufrufer zugewiesenen Puffer. Bei erfolgreicher Rückgabe enthält dieser Puffer zusätzliche Informationen zum Status der Datei. Wenn dieser Wert angegeben wird, muss auch BufferLength angegeben werden. Datenstrukturen für jeden definierten Anbieter sind:

WOF_PROVIDER_WIM WIM_EXTERNAL_FILE_INFO
WOF_PROVIDER_FILE WOF_FILE_COMPRESSION_INFO

[in, out, optional] BufferLength

Zeigt optional auf einen Wert, der die Länge des in ExternalFileInfo angegebenen Puffers enthält. Bei der Rückgabe wird dieser Wert auf die Größe des verbrauchten Puffers oder die Größe des erforderlichen Puffers festgelegt. Wenn der Puffer nicht ausreichend lang ist, gibt diese Funktion erfolgreich die erforderliche Größe an und füllt den Puffer in ExternalFileInfo nicht auf. Diese Länge sollte einer der oben definierten Strukturen entsprechen:

WOF_PROVIDER_WIM sizeof(WIM_EXTERNAL_FILE_INFO)
WOF_PROVIDER_FILE sizeof(WOF_FILE_COMPRESSION_INFO)

Rückgabewert

Diese Funktion gibt ein HRESULT zurück, das den Erfolg oder den Grund für einen Fehler angibt. Wenn der in ExternalFileInfo angegebene Puffer nicht die richtige Größe aufweist, gibt die Funktion S_OK zurück und gibt die erforderliche Puffergröße in BufferLength an.

Anforderungen

Anforderung Wert
Zielplattform Windows
Kopfzeile wofapi.h
Bibliothek Wofutil.lib
DLL Wofutil.dll

Weitere Informationen

FSCTL_GET_EXTERNAL_BACKING