CfGetPlaceholderInfo-Funktion (cfapi.h)
Ruft verschiedene Merkmale einer Platzhalterdatei oder eines Ordners ab. Wenn die Datei kein Platzhalter für Clouddateien ist, schlägt die API fehl. Bei Erfolg werden Informationen gemäß der spezifischen angeforderten InfoClass zurückgegeben.
Syntax
HRESULT CfGetPlaceholderInfo(
[in] HANDLE FileHandle,
[in] CF_PLACEHOLDER_INFO_CLASS InfoClass,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] PDWORD ReturnedLength
);
Parameter
[in] FileHandle
Ein Handle für den Platzhalter, dessen Informationen abgefragt werden. Im Gegensatz zu den meisten Clouddateien-APIs, die ein Dateihandle verwenden, ändert dieser die Datei in keiner Weise. Daher erfordert das Dateihandle nur READ_ATTRIBUTES Zugriff.
[in] InfoClass
Platzhalterinformationen. Dies kann entweder auf CF_PLACEHOLDER_STANDARD_INFO oder CF_PLACEHOLDER_BASIC_INFO festgelegt werden.
[out] InfoBuffer
Ein Zeiger auf einen Puffer, der Informationen zum Platzhalter empfängt.
[in] InfoBufferLength
Die Länge des InfoBuffers in Bytes. Wenn der Puffer nicht groß genug ist, um alle angeforderten Informationen aufzunehmen, gibt die API so viele Daten zurück, wie sie in den Puffer passen kann, und der Aufruf schlägt mit HRESULT_FROM_WIN32(ERROR_MORE_DATA) fehl.
[out, optional] ReturnedLength
Die Anzahl der im InfoBuffer zurückgegebenen Bytes.
Rückgabewert
Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.
Hinweise
Platzhalterinformationen umfassen die folgenden Attribute:
| attribute | BESCHREIBUNG |
|---|---|
| OnDiskDatasize | Die Gesamtanzahl der Bytes auf dem Datenträger. |
| ValidatedDataSize | Die Gesamtzahl der Bytes, die mit der Cloud synchronisiert sind. |
| ModifiedDataSize | Die Gesamtzahl der Bytes, die lokal überschrieben/angefügt wurden, d. h. nicht mit der Cloud synchronisiert. |
| PropertiesSize | Die Gesamtanzahl der Bytes auf dem Datenträger, die von allen Eigenschaftenblobs verwendet wird. |
| PinState | Weitere Informationen finden Sie unter CfSetPinState . |
| InSyncState | Weitere Informationen finden Sie unter CfSetInSyncState . |
| FileId | Eine 64-Bit-Volumeweite nicht flüchtige Zahl, die eine Datei oder ein Verzeichnis eindeutig identifiziert. |
| SyncRootFileId | Die Datei-ID des Synchronisierungsstammverzeichnisses, unter dem sich die Datei befindet, deren Platzhalterinformationen abgefragt werden sollen. |
| FileIdentity | Ein undurchsichtiges Blob, das vom Synchronisierungsanbieter für die Plattform bereitgestellt wurde, als der Platzhalter erstellt wurde. Die Dateiidentität wird für alle Rückrufe des Synchronisierungsanbieters bereitgestellt. |
| FileIdentityLength | Die Länge der Dateiidentität in Bytes. |
Anforderungen
| Anforderung | Wert |
|---|---|
| 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 |