cfGetSyncRootInfoByPath 函数 (cfapi.h)

  • 项目

获取给定同步根目录下的文件的各种同步根信息。

语法

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

参数

[in] FilePath

要查询其同步根信息的文件的完全限定路径。

[in] InfoClass

同步根信息的类型。

[out] InfoBuffer

指向将接收同步根信息的缓冲区的指针。

[in] InfoBufferLength

InfoBuffer 的长度（以字节为单位）。

[out, optional] ReturnedLength

返回的同步根信息的长度（以字节为单位）。 有关同步根信息的详细信息，请参阅 CfRegisterSyncRoot 。

返回值

如果此函数成功，则返回 S_OK。 否则，它将返回 HRESULT 错误代码。

注解

如果文件不在云文件同步根目录下，API 将失败。 成功后，将根据请求的特定 InfoClass 返回信息。

InfoClass 参数可以是CF_SYNC_ROOT_INFO_CLASS中的下列值之一：

  • CF_SYNC_ROOT_INFO_BASIC
  • CF_SYNC_ROOT_INFO_STANDARD
  • CF_SYNC_ROOT_INFO_PROVIDER

要求

   
最低受支持的客户端 Windows 10版本 1709 [仅限桌面应用]
最低受支持的服务器 Windows Server 2016 [仅限桌面应用]
目标平台 Windows
标头 cfapi.h
Library CldApi.lib
DLL CldApi.dll

另请参阅

CfRegisterSyncRoot

CfGetSyncRootInfoByHandle