CfGetSyncRootInfoByHandle 函数 (cfapi.h)

  • 项目

获取包含由文件句柄指定的给定文件的同步根的各种特征。

语法

HRESULT CfGetSyncRootInfoByHandle(
  [in]            HANDLE                  FileHandle,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

参数

[in] FileHandle

要查询其信息的同步根下的文件的句柄。

[in] InfoClass

同步根信息的类型。

[out] InfoBuffer

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

[in] InfoBufferLength

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

[out, optional] ReturnedLength

InfoBuffer 中返回的字节数。

返回值

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

注解

与采用文件句柄的大多数占位符 API 不同，此占位符 API 不会以任何方式修改文件，因此 FileHandle 只需要 READ_ATTRIBUTES 访问权限。

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

要求

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

另请参阅

CfGetSyncRootInfoByPath