CfGetSyncRootInfoByHandle-Funktion (cfapi.h)
Ruft verschiedene Merkmale des Synchronisierungsstamms ab, der eine durch ein Dateihandle angegebene Datei enthält.
Syntax
HRESULT CfGetSyncRootInfoByHandle(
[in] HANDLE FileHandle,
[in] CF_SYNC_ROOT_INFO_CLASS InfoClass,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] DWORD *ReturnedLength
);
Parameter
[in] FileHandle
Handle der Datei unter dem Synchronisierungsstamm, deren Informationen abgefragt werden sollen.
[in] InfoClass
Typen von Synchronisierungsstamminformationen.
[out] InfoBuffer
Ein Zeiger auf einen Puffer, der die Synchronisierungsstamminformationen empfängt.
[in] InfoBufferLength
Länge des InfoBuffers in Bytes.
[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
Im Gegensatz zu den meisten Platzhalter-APIs, die ein Dateihandle verwenden, ändert dieser die Datei in keiner Weise, daher erfordert fileHandle nur READ_ATTRIBUTES Zugriff.
Wenn sich die Datei nicht unter einem Clouddateisynchronisierungsstamm befindet, schlägt die API fehl. Bei Erfolg werden Informationen entsprechend der spezifischen angeforderten InfoClass zurückgegeben.
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 |