setEndOfFile 函数 (fileapi.h)

将指定文件的物理文件大小设置为文件指针的当前位置。

物理文件大小也称为文件末尾。 SetEndOfFile 函数可用于截断或扩展文件。 若要设置文件的逻辑端,请使用 SetFileValidData 函数。

语法

BOOL SetEndOfFile(
  [in] HANDLE hFile
);

参数

[in] hFile

要扩展或截断的文件的句柄。

必须使用 GENERIC_WRITE 访问权限创建文件句柄。 有关详细信息,请参阅 文件安全和访问权限

返回值

如果该函数成功,则返回值为非零值。

如果函数失败,则返回值为零 (0)。 要获得更多的错误信息,请调用 GetLastError。

注解

SetEndOfFile 函数可用于截断或扩展文件。 如果文件已扩展,则不会定义文件旧端与文件新端之间的文件内容。

每个文件流具有以下项:

  • 文件大小:文件中数据的大小(字节)。
  • 分配大小:为磁盘上的文件分配的空间大小,始终是群集大小的偶数倍。
  • 有效数据长度:实际写入到 字节的文件中数据的长度。 此值始终小于或等于文件大小。
SetEndOfFile 函数设置文件大小。 使用 SetFileValidData 设置有效的数据长度。

如果
调用 CreateFileMappinghFile 创建文件映射对象,必须先调用 UnmapViewOfFile 以取消映射所有视图,并调用 CloseHandle 以关闭文件映射对象,然后才能调用 SetEndOfFile

事务处理操作

如果存在绑定到句柄的事务,则会事务处理文件末尾位置的更改。

在 Windows 8 和 Windows Server 2012 中,此函数由以下技术支持。

技术 支持
服务器消息块 (SMB) 3.0 协议
SMB 3.0 透明故障转移 (TFO)
具有横向扩展文件共享的 SMB 3.0 (SO)
群集共享卷文件系统 (CSV)
弹性文件系统 (ReFS)

要求

   
最低受支持的客户端 Windows XP [桌面应用 | UWP 应用]
最低受支持的服务器 Windows Server 2003 [桌面应用 | UWP 应用]
目标平台 Windows
标头 fileapi.h (包括 Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

另请参阅

CloseHandle

CreateFile

CreateFileMapping

文件管理函数

SetFileInformationByHandle

SetFileValidData

UnmapViewOfFile