Delphi WinAPI CreateFile函数

Delphi WinAPI CreateFile函数

原型：

HANDLE CreateFile(
  LPCTSTR lpFileName, //指向文件名的指针
  DWORD dwDesiredAccess, //访问模式（写/读）
  DWORD dwShareMode, //共享模式
  LPSECURITY_ATTRIBUTES lpSecurityAttributes, //指向安全属性的指针 DWORD 
  dwCreationDisposition, //如何创建
  DWORD dwFlagsAndAttributes, //文件属性
  HANDLE hTemplateFile //用于复制文件句柄
);

参数的说明：

• lpFileName
• 指向一个空结尾字符串。该参数指定了用于创建或打开句柄的对象。 如果lpFileName的对象是一个路径，则有一个最大字符数的限制。不能超过常量(MAX_PATH).这个限制指示了CreateFile函数如何解析路径.
• dwDesiredAccess
• 指定对象的访问方式,程序可以获得读访问权,写访问权,读写访问权或者是询问设备("device query") 访问权. 指定询问访问权.程序可以在不直接访问设备的情况下查询设备的属性.这个参数可以是下列值的任意组合:
  • 　　GENERIC_READ  // 指定读访问权.可以从文件中读取数据,并且移动文件指针.可以和GENERIC_WRITE组合成为"读写访问权".
  • 　　GENERIC_WRITE  //指定写访问权.可以从文件中写入数据,并且移动文件指针.可以和GENERIC_READ组合成为"读写访问权".
• dwShareMode 设置位标志指明对象如何共享.如果参数是0, 对象不能够共享. 后续的打开对象的操作将会失败,直到该对象的句柄关闭. 使用一个或多个下列值的组合来共享一个对象.
  • 　　FILE_SHARE_DELETE  //WINDOWS NT:后续的仅仅请求删除访问权的打开操作将会成功.
  • 　　FILE_SHARE_READ  //后续的仅仅请求读访问权的打开操作将会成功.
  • 　　FILE_SHARE_WRITE  //后续的仅仅请求写访问权的打开操作将会成功.
• lpSecurityAttributes
• 指向一个 SECURITY_ATTRIBUTES 结构的指针用于确定如何在子进程中继承这个句柄.如果这个参数是NULL,则该句柄不可继承.
• dwCreationDisposition
• 指定当文件存在或者不存在时如何动作。关于这个参数更多的信息，参考批注部分。这个参数必须是一个或多个下列值。
  • 　　CREATE_NEW //创建一个新文件. 如果该文件已经存在函数则会失败.
  • 　　CREATE_ALWAYS //创建一个新文件.如果该文件已经存在,函数将覆盖已存在的文件并清除已存在的文件属性
  • 　　OPEN_EXISTING //打开一个文件,如果文件不存在函数将会失败.如查你使用CreateFile函数为设备装载控制台.请查看批注中的"为什么使用OPEN_EXISTING标志"的部分.
  • 　　OPEN_ALWAYS  //如果文件存在,打开文件. 如果文件不存在,并且参数中有CREATE_NEW标志,则创建文件.
  • 　　TRUNCATE_EXISTING  //打开一个文件,每次打开,文件将被截至0字节.调用进程必须用GENERIC_WRITE访问模式打开文件.如果文件不存在则函数就会失败.
• dwFlagsAndatributes
• 为文件指定属性和标志位 该参数可以接收下列属性的任意组合.
  • 　　FILE_ATTRIBUTE_NORMAL //文件正常，则忽略所有文件属性
  • 　　FILE_ATTRIBUTE_ARCHIVE //文件将被存档,程序使用此属性来标志文件去备份或移除
  • 　　FILE_ATTRIBUTE_HIDDEN  //文件被隐藏,它不会在一般文件夹列表中被装载.FILE_ATTRIBUTE_NORMAL 文件没有被设置任何属性.
  • 　　FILE_ATTRIBUTE_OFFLINE  //文件的数据没有被立即用到。指出正在脱机使用该文件。
  • 　　FILE_ATTRIBUTE_READONLY  //这个文件只可读取.程序可以读文件,但不可以在上面写入内容,也不可删除.
  • 　　FILE_ATTRIBUTE_SYSTEM //文件是系统的一部分,或是系统专用的.
  • 　　FILE_ATTRIBUTE_TEMPORARY  //文件被使用后，文件系统将努力为（文件的）所有数据的迅迅访问保持一块内存。临时文件应当在程序不用时及时删除。
    • dwFlagAndAttributes可以接受下列标志的任意组合。
      • FILE_FLAG_WRITE_THROUGH  //指示系统通过快速缓存直接写入磁盘.
      • FILE_FLAG_OVERLAPPED //指示系统初始化对象, 此操作将对进程设置一个引用计数并返回ERROR_IO_PENDING.处理完成后, 指定对象将被设置为信号状态.当你指定
      • FILE_FLAG_OVERLAPPED时,读写文件的函数必须指定一个OVERLAPPED结构.并且. 当FILE_FLAG_OVERLAPPED被指定, 程序必须执行重叠参数(指向OVERLAPPED结构)去进行文件的读写.这个标志也可以有超过一个操作去执行.
      • FILE_FLAG_NO_BUFFERING //指示系统不使用快速缓冲区或缓存，当和FILE_FLAG_OVERLAPPED组合,该标志给出最大的异步操作量, 因为I/O不依赖内存管理器的异步操作.然而,一些I/O操作将会运行得长一些,因为数据没有控制在缓存中.当使用
      • FILE_FLAG_NO_BUFFERING //打开文件进行工作时,程序必须达到下列要求:
        • • 1、文件的存取开头的字节偏移量必须是扇区尺寸的整倍数.
          • 2、文件存取的字节数必须是扇区尺寸的整倍数.例如,如果扇区尺寸是512字节程序就可以读或者写512,1024或者2048字节,但不能够是335,981或者7171字节.
          • 3、进行读和写操作的地址必须在扇区的对齐位置,在内存中对齐的地址是扇区尺寸的整倍数.
          • 4、一个将缓冲区与扇区尺寸对齐的途径是使用VirtualAlloc函数.它分配与操作系统内存页大小的整倍数对齐的内存地址.因为内存页尺寸和扇区尺寸--2都是它们的幂.
          • 5、这块内存在地址中同样与扇区尺寸大小的整倍数对齐.
          • 6、程序可以通过调用GetDiskFreeSpace来确定扇区的尺寸.
      • FILE_FLAG_RANDOM_ACCESS //指定文件是随机访问,这个标志可以使系统优化文件的缓冲.
      • FILE_FLAG_SEQUENTIAL_SCAN  //指定文件将从头到尾连续地访问.这个标志可以提示系统优化文件缓冲. 如果程序在随机访问文件中移动文件指针,优化可能不会发生;然而,正确的操作仍然可以得到保证指定这个标志可以提高程序以顺序访问模式读取大文件的性能, 性能的提高在许多程序读取一些大的顺序文件时是异常明显的.但是可能会有小范围的字节遗漏.
      • FILE_FLAG_DELETE_ON_CLOSE  //指示系统在文件所有打开的句柄关闭后立即删除文件.不只有你可以指定FILE_FLAG_DELETE_ON_CLOSE如果没有使用FILE_SHARE_DELETE,后续的打开文件的请求将会失败.
      • FILE_FLAG_BACKUP_SEMANTICS  //WINDOWS NT:指示系统为文件的打开或创建执行一个备份或恢复操作. 系统保证调用进程忽略文件的安全选项,倘若它必须有一个特权.则相关的特权则是SE_BACKUP_NAME和SE_RESTORE_NAME. 你也可以使用这个标志获得一个文件夹的句柄，一个文件夹句柄能够象一个文件句柄一样传给某些Win32函数。
      • FILE_FLAG_POSIX_SEMANTICS //指明文件符合POSIX标准.这是在MS-DOS与16位Windows下的标准.
      • FILE_FLAG_OPEN_REPARSE_POINT //指定这个标志制约NTFS分区指针.该标志不能够和CREAT_ALWAYS一起使用.
      • FILE_FLAG_OPEN_NO_RECALL //指明需要文件数据,但是将继续从远程存储器中接收.它不会将数据存放在本地存储器中.这个标志由远程存储系统或等级存储管理器系统使用.
• hTemplateFile
• 为GENERIC_READ访问的模式指定一个句柄到模板文件.模板文件在文件开始创建后提供文件属性和扩展属性.
• Return Values返回值 如果函数成功,返回一个打开的指定文件的句柄.如果指定文件在函数调用前已经存在并且dwCreation参数是CREATE_ALWAYS 或者OPEN_ALWAYS,调用GetLastError就会返回ERROR_ALREADY_EXISTS(表示函数成功). 如果函数文件在调用前不存在则会返回0. 如果函数失败,返会值会是INVALID_HANDLE_VALUE. 更多的错误信息可以调用GetLastError来获得.

Delphi 代码示例：（判断文件是否正在被使用）

function IsFileInUse(fName: string): boolean;
var
  HFileRes: HFILE;
begin
  Result := false; //返回值为假(即文件不被使用)
  if not FileExists(fName) then exit; //如果文件不存在则退出
  HFileRes := CreateFile(pchar(fName), GENERIC_READ or GENERIC_WRITE, 0, nil, OPEN_EXISTING,FILE_ATTRIBUTE_NORMAL, 0);
  Result := (HFileRes = INVALID_HANDLE_VALUE); //如果CreateFile返回失败 那么Result为真(即文件正在被使用)
  if not Result then CloseHandle(HFileRes); //如果CreateFile函数返回是成功那么关闭句柄
end;

函数的调用方法：IsFileInUse(要判断的文件路径); 如果函数返回True 则正在使用,False则文件现在没被使用

创建时间：2020.05.08　　更新时间：