CfGetPlaceholderRangeInfo 函数 (cfapi.h)
获取有关占位符文件或文件夹的范围信息。
语法
HRESULT CfGetPlaceholderRangeInfo(
[in] HANDLE FileHandle,
[in] CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
[in] LARGE_INTEGER StartingOffset,
[in] LARGE_INTEGER Length,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] PDWORD ReturnedLength
);
参数
[in] FileHandle
要查询的占位符文件的句柄。
[in] InfoClass
占位符数据范围的类型。
[in] StartingOffset
数据范围的起始点偏移量。
[in] Length
数据范围的长度。 提供程序可以指定 CF_EOF
Length ,以指示请求信息的范围从 StartingOffset 到文件末尾。
[out] InfoBuffer
指向将接收数据的缓冲区的指针。 缓冲区是 CF_FILE_RANGE 结构的数组,这些结构是偏移/长度对,用于描述请求的范围。
[in] InfoBufferLength
InfoBuffer 的长度(以字节为单位)。
[out, optional] ReturnedLength
InfoBuffer 中返回的占位符数据的长度范围。
返回值
如果此函数成功,则返回 S_OK
。 否则,它将返回 HRESULT 错误代码。 下表中列出了一些常见的错误代码:
错误代码 | 含义 |
---|---|
HRESULT_FROM_WIN32 ( ERROR_HANDLE_EOF ) | 这意味着 StartingOffset> = 文件末尾的位置。 |
HRESULT_FROM_WIN32 ( ERROR_MORE_DATA ) | 这意味着下一 个CF_FILE_RANGE 项不适合提供的缓冲区。 调用方应验证是否收到任何条目,或者是否使用返回的 InfoBufferWritten 值。 |
注解
与采用文件句柄的大多数占位符 API 不同,此占位符 API 不会以任何方式修改文件,因此文件句柄只需要READ_ATTRIBUTES访问。
要求
最低受支持的客户端 | Windows 10版本 1709 [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2016 [仅限桌面应用] |
目标平台 | Windows |
标头 | cfapi.h |
Library | CldApi.lib |
DLL | CldApi.dll |