CfGetSyncRootInfoByPath-Funktion (cfapi.h)

  • Artikel

Ruft verschiedene Synchronisierungsstamminformationen ab, wenn eine Datei unter dem Synchronisierungsstammverzeichnis angegeben wird.

Syntax

HRESULT CfGetSyncRootInfoByPath(
  [in]            LPCWSTR                 FilePath,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

Parameter

[in] FilePath

Ein vollqualifizierter Pfad zu einer Datei, deren Synchronisierungsstamminformationen 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

Länge der zurückgegebenen Synchronisierungsstamminformationen in Bytes. Ausführliche Informationen zu den Synchronisierungsstamminformationen finden Sie unter CfRegisterSyncRoot .

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Hinweise

Wenn sich die Datei nicht unter einem Clouddateisynchronisierungsstamm befindet, schlägt die API fehl. Bei Erfolg werden Informationen gemäß der spezifischen angeforderten InfoClass zurückgegeben.

Der InfoClass-Parameter kann einer der folgenden Werte aus CF_SYNC_ROOT_INFO_CLASS sein:

  • CF_SYNC_ROOT_INFO_BASIC
  • CF_SYNC_ROOT_INFO_STANDARD
  • CF_SYNC_ROOT_INFO_PROVIDER

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

CfRegisterSyncRoot

CfGetSyncRootInfoByHandle