CfGetPlaceholderRangeInfo-Funktion (cfapi.h)

  • Artikel

Ruft Bereichsinformationen zu einer Platzhalterdatei oder einem Ordner ab.

Syntax

HRESULT CfGetPlaceholderRangeInfo(
  [in]            HANDLE                          FileHandle,
  [in]            CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
  [in]            LARGE_INTEGER                   StartingOffset,
  [in]            LARGE_INTEGER                   Length,
  [out]           PVOID                           InfoBuffer,
  [in]            DWORD                           InfoBufferLength,
  [out, optional] PDWORD                          ReturnedLength
);

Parameter

[in] FileHandle

Das Handle der abzufragten Platzhalterdatei.

[in] InfoClass

Typen des Bereichs von Platzhalterdaten.

[in] StartingOffset

Offset des Startpunkts des Datenbereichs.

[in] Length

Länge des Datenbereichs. Ein Anbieter kann für Length angebenCF_EOF, um anzugeben, dass der Bereich, für den Informationen angefordert werden, von StartingOffset bis zum Ende der Datei ist.

[out] InfoBuffer

Zeiger auf einen Puffer, der die Daten empfängt. Der Puffer ist ein Array von CF_FILE_RANGE Strukturen, bei denen es sich um Offset-Länge-Paare handelt, die die angeforderten Bereiche beschreiben.

[in] InfoBufferLength

Die Länge von InfoBuffer in Bytes.

[out, optional] ReturnedLength

Die Länge des zurückgegebenen Bereichs von Platzhalterdaten im InfoBuffer.

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben. Einige häufige Fehlercodes sind in der folgenden Tabelle aufgeführt:

Fehlercode Bedeutung
HRESULT_FROM_WIN32( ERROR_HANDLE_EOF ) Dies bedeutet, dass StartingOffset>= die Position des Endes der Datei ist.
HRESULT_FROM_WIN32( ERROR_MORE_DATA ) Dies bedeutet, dass der nächste CF_FILE_RANGE Eintrag nicht in den bereitgestellten Puffer passt. Der Aufrufer sollte überprüfen, ob ein Eintrag empfangen wird oder nicht den zurückgegebenen InfoBufferWritten-Wert verwendet.

Hinweise

Im Gegensatz zu den meisten Platzhalter-APIs, die ein Dateihandle verwenden, ändert dieser die Datei in keiner Weise, daher erfordert das Dateihandle nur READ_ATTRIBUTES Zugriff.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 10, Version 1709 [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2016 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile cfapi.h
Bibliothek CldApi.lib
DLL CldApi.dll

Siehe auch

CfGetPlaceholderRangeInfoForHydration