createFileA 函数 (fileapi.h)
创建或者打开文件或 I/O 设备。 最常用的 I/O 设备如下:文件、文件流、目录、物理磁盘、卷、控制台缓冲区、磁带驱动器、通信资源、mailslot 和管道。 函数返回一个句柄,该句柄可用于访问各种类型的 I/O 的文件或设备,具体取决于文件或设备以及指定的标志和属性。
若要以事务处理操作的形式执行此操作,这会生成可用于事务处理 I/O 的句柄,请使用 CreateFileTransacted 函数。
语法
HANDLE CreateFileA(
[in] LPCSTR lpFileName,
[in] DWORD dwDesiredAccess,
[in] DWORD dwShareMode,
[in, optional] LPSECURITY_ATTRIBUTES lpSecurityAttributes,
[in] DWORD dwCreationDisposition,
[in] DWORD dwFlagsAndAttributes,
[in, optional] HANDLE hTemplateFile
);
参数
[in] lpFileName
要创建或打开的文件或设备的名称。 可在此名称中使用正斜杠 (/) 或反斜杠 (\) 。
默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 个宽字符,请在路径前面添加“\\?\”。 有关详细信息,请参阅命名文件、路径和命名空间。
提示
从 Windows 10 版本 1607 开始,可以选择删除MAX_PATH限制,而无需在前面添加“\\?\”。 有关详细信息,请参阅 命名文件、路径和命名空间 的“最大路径长度限制”部分。
有关特殊设备名称的信息,请参阅 定义 MS-DOS 设备名称。
若要创建文件流,请指定文件的名称、冒号,然后指定流的名称。 有关详细信息,请参阅 文件流。
[in] dwDesiredAccess
请求对文件或设备的访问权限,可以汇总为读取、写入或 0,以指示两者都不) 。
最常用的值是 GENERIC_READ、 GENERIC_WRITE或两者 (GENERIC_READ | GENERIC_WRITE
) 。 有关详细信息,请参阅 通用访问权限、 文件安全性和访问权限、 文件访问权限常量和 ACCESS_MASK。
如果此参数为零,则应用程序可以在不访问该文件或设备的情况下查询某些元数据(如文件、目录或设备属性),即使 GENERIC_READ 访问被拒绝也是如此。
不能请求与已打开句柄的打开请求中的 dwShareMode 参数指定的共享模式冲突的访问模式。
有关详细信息,请参阅本主题的“备注”部分和 “创建和打开文件”。
[in] dwShareMode
请求的文件或设备的共享模式(可读取、写入、删除、所有这些共享模式或无 (请参阅下表) 。 对属性或扩展属性的访问请求不受此标志的影响。
如果此参数为零且 CreateFile 成功,则在关闭文件或设备的句柄之前,无法共享文件或设备,并且无法再次打开。 有关详细信息,请参见“备注”部分。
不能请求与具有打开句柄的现有请求中指定的访问模式冲突的共享模式。 CreateFile 将失败, GetLastError 函数将返回 ERROR_SHARING_VIOLATION。
若要使某个进程能够在另一个进程打开文件或设备时共享文件或设备,请使用以下一个或多个值的兼容组合。 有关此参数与 dwDesiredAccess 参数的有效组合的详细信息,请参阅 创建和打开文件。
[in, optional] lpSecurityAttributes
指向 SECURITY_ATTRIBUTES 结构的指针,该结构包含两个独立但相关的数据成员:可选的安全描述符,以及一个布尔值,用于确定是否可由子进程继承返回的句柄。
此参数可以为 NULL。
如果此参数为 NULL,则应用程序可能创建的任何子进程都不能继承 CreateFile 返回的句柄,并且与返回的句柄关联的文件或设备将获取默认安全描述符。
结构的 lpSecurityDescriptor 成员指定文件或设备的 SECURITY_DESCRIPTOR 。 如果此成员为 NULL,则会为与返回的句柄关联的文件或设备分配默认安全描述符。
CreateFile 在打开现有文件或设备时忽略 lpSecurityDescriptor 成员,但仍继续使用 bInheritHandle 成员。
结构的 bInheritHandle 成员指定是否可以继承返回的句柄。
有关详细信息,请参见“备注”部分。
[in] dwCreationDisposition
要对存在或不存在的文件或设备执行的操作。
对于文件以外的设备,此参数通常设置为 OPEN_EXISTING。
有关详细信息,请参见“备注”部分。
此参数必须是下列值之一,这些值不能合并:
[in] dwFlagsAndAttributes
文件或设备属性和标志 FILE_ATTRIBUTE_NORMAL 是文件最常见的默认值。
此参数可以包含可用文件属性的任意组合 (FILE_ATTRIBUTE_*) 。 所有其他文件属性都替代 FILE_ATTRIBUTE_NORMAL。
此参数还可以包含用于控制文件或设备缓存行为、访问模式和其他特殊用途标志的标志 (FILE_FLAG_*) 的组合。 这些值与任何 FILE_ATTRIBUTE_* 值结合使用。
此参数还可以通过指定 SECURITY_SQOS_PRESENT 标志来包含安全服务质量 (SQOS ) 信息。 属性和标志表后面的表中显示了与 SQOS 相关的其他标志信息。
有关对文件属性的更高级访问,请参阅 SetFileAttributes。 有关所有文件属性及其值和说明的完整列表,请参阅 文件属性常量。
Attribute | 含义 |
---|---|
|
文件应存档。 应用程序使用此属性来标记要备份或删除的文件。 |
|
此文件或目录已加密。 对于文件来说,表示文件中的所有数据都是加密的。 对于目录,这意味着加密是新创建的文件和子目录的默认设置。 有关详细信息,请参阅 文件加密。
如果还指定 了FILE_ATTRIBUTE_SYSTEM ,则此标志无效。 家庭版、家庭高级版、初学者版或 ARM 版本的 Windows 不支持此标志。 |
|
文件被隐藏。 不要将其包含在普通目录列表中。 |
|
该文件未设置其他属性。 此属性仅在单独使用时有效。 |
|
文件的数据不会立即可用。 此属性指示文件数据以物理方式移动到脱机存储。 远程存储(分层存储管理软件)使用此属性。 应用程序不应随意更改此属性。 |
|
文件为只读文件。 应用程序可以读取文件,但不能写入或删除它。 |
|
该文件是操作系统的一部分或由操作系统独占使用。 |
|
该文件用于临时存储。
有关详细信息,请参阅本主题的 缓存行为 部分。 |
标志 | 含义 |
---|---|
|
正在为备份或还原操作打开或创建文件。 当进程具有 SE_BACKUP_NAME 和 SE_RESTORE_NAME 权限时,系统将确保调用进程替代文件安全检查。 有关详细信息,请参阅 更改令牌中的特权。
必须设置此标志才能获取目录的句柄。 目录句柄可以传递给某些函数,而不是文件句柄。 有关详细信息,请参见“备注”部分。 |
|
文件在其所有句柄都关闭后立即被删除,其中包括指定的句柄和任何其他打开或重复的句柄。
如果存在文件的现有打开句柄,则调用会失败,除非它们都以 FILE_SHARE_DELETE 共享模式打开。 针对文件的后续打开请求将失败,除非指定 FILE_SHARE_DELETE 共享模式。 |
|
正在打开文件或设备,没有系统缓存用于数据读取和写入。 此标志不会影响硬盘缓存或内存映射文件。
使用 FILE_FLAG_NO_BUFFERING 标志成功处理使用 CreateFile 打开的文件有严格的要求,有关详细信息,请参阅文件缓冲。 |
|
文件数据已请求,但应继续位于远程存储中。 不应将其传输回本地存储。 此标志供远程存储系统使用。 |
|
不会进行正常的 重分析点 处理; CreateFile 将尝试打开重新分析点。 打开文件时,无论控制重分析点的筛选器是否正常运行,都返回文件句柄。
此标志不能与 CREATE_ALWAYS 标志一起使用。 如果文件不是重分析点,则忽略此标志。 有关详细信息,请参见“备注”部分。 |
|
正在为异步 I/O 打开或创建文件或设备。
在此句柄上完成后续 I/O 操作时, OVERLAPPED 结构中指定的事件将设置为信号状态。 如果指定了此标志,则文件可用于同时读取和写入操作。 如果未指定此标志,则 I/O 操作将序列化,即使对读取和写入函数的调用指定 了 OVERLAPPED 结构也是如此。 有关使用此标志创建的文件句柄时的注意事项的信息,请参阅本主题的 同步和异步 I/O 句柄 部分。 |
|
将根据 POSIX 规则进行访问。 这包括允许多个具有名称的文件(仅在大小写上不同)用于支持该命名的文件系统。 使用此选项时请小心,因为为 MS-DOS 或 16 位 Windows 编写的应用程序可能无法访问使用此标志创建的文件。 |
|
访问应是随机的。 系统可将此选项用作优化文件缓存的提示。
如果文件系统不支持缓存的 I/O 且 FILE_FLAG_NO_BUFFERING,则此标志无效。 有关详细信息,请参阅本主题的 缓存行为 部分。 |
|
正在使用会话感知打开文件或设备。 如果未指定此标志,则会话 0 中运行的进程无法打开每个会话 (设备,例如使用 RemoteFX USB 重定向) 的设备。
此标志对不在会话 0 中的调用方无效。 此标志仅在服务器版本的 Windows 上受支持。
Windows Server 2008 R2 和 Windows Server 2008: 在Windows Server 2012之前,不支持此标志。 |
|
访问旨在从头到尾按顺序进行。 系统可将此选项用作优化文件缓存的提示。
如果读取隐藏 (即使用反向扫描) ,则不应使用此标志。 如果文件系统不支持缓存的 I/O 且 FILE_FLAG_NO_BUFFERING,则此标志无效。 有关详细信息,请参阅本主题的 缓存行为 部分。 |
|
写入操作不会通过任何中间缓存,它们将直接转到磁盘。
有关其他信息,请参阅本主题的 缓存行为 部分。 |
dwFlagsAndAttributes 参数还可以指定 SQOS 信息。 有关详细信息,请参阅 模拟级别。 当调用应用程序将 SECURITY_SQOS_PRESENT 标志指定为 dwFlagsAndAttributes 的一部分时,它还可以包含以下一个或多个值。
[in, optional] hTemplateFile
具有 GENERIC_READ 访问权限的模板文件的有效句柄。 模板文件为正在创建的文件提供文件属性和扩展属性。
此参数可以为 NULL。
打开现有文件时, CreateFile 将忽略此参数。
打开新的加密文件时,该文件会从其父目录继承自由访问控制列表。 有关详细信息,请参阅 文件加密。
返回值
如果函数成功,则返回值是指定文件、设备、命名管道或邮件槽的打开句柄。
如果函数失败,则返回值为 INVALID_HANDLE_VALUE。 要获得更多的错误信息,请调用 GetLastError。
注解
CreateFile 最初专为文件交互而开发,但后来进行了扩展和增强,以包括 Windows 开发人员可用的大多数其他类型的 I/O 设备和机制。 本部分尝试介绍开发人员在不同上下文和不同 I/O 类型中使用 CreateFile 时可能遇到的各种问题。 仅当专门引用存储在文件系统上实际文件中的数据时,文本才会尝试使用单词 file 。 但是, 文件 的某些用途可能更一般地引用支持类似文件的机制的 I/O 对象。 由于前面提到的历史原因,这种对 术语文件 的自由使用在常量名称和参数名称中尤其普遍。
当应用程序使用 CreateFile 返回的对象句柄完成时,请使用 CloseHandle 函数关闭句柄。 这不仅释放了系统资源,而且对共享文件或设备以及将数据提交到磁盘等事项产生了更广泛的影响。 本主题中会根据需要说明具体内容。
Windows Server 2003 和 Windows XP: 如果 dwDesiredAccess 参数的值为 DELETE 访问标志 (0x00010000) OR 与任何其他访问标志一起,并且尚未使用 FILE_SHARE_DELETE 打开远程文件或目录,则会发生共享冲突。 若要避免在此方案中发生共享冲突,请仅使用 DELETE 访问权限打开远程文件或目录,或者调用 DeleteFile 而不先打开文件或目录进行删除。
某些文件系统(如 NTFS 文件系统)支持对单个文件和目录进行压缩或加密。 在具有具有此支持的已装载文件系统的卷上,新文件继承其目录的压缩和加密属性。
不能使用 CreateFile 来控制文件或目录上的压缩、解压缩或解密。 有关详细信息,请参阅 创建和打开文件、 文件压缩和解压缩以及 文件加密。
Windows Server 2003 和 Windows XP: 为了向后兼容,在 lpSecurityAttributes 中指定安全描述符时,CreateFile 不会应用继承规则。 为了支持继承,稍后查询此文件的安全描述符的函数可以启发式确定并报告继承是否有效。 有关详细信息,请参阅 可继承 ACE 的自动传播。
如前所述,如果 lpSecurityAttributes 参数为 NULL,则应用程序可能创建的任何子进程都不能继承 CreateFile 返回的句柄。 有关此参数的以下信息也适用:
- 如果 bInheritHandle 成员变量不是 FALSE(这是任何非零值),则可以继承句柄。 因此,如果不希望句柄可继承,则必须将此结构成员正确初始化为 FALSE 。
- 文件或目录的默认安全描述符中的访问控制列表 (ACL) 是从其父目录继承的。
- 目标文件系统必须支持文件和目录的安全性, lpSecurityDescriptor 成员才能对它们产生影响,这可以通过使用 GetVolumeInformation 确定。
技术 | 支持 |
---|---|
服务器消息块 (SMB) 3.0 协议 | 是 |
SMB 3.0 透明故障转移 (TFO) | 查看备注 |
具有横向扩展文件共享的 SMB 3.0 (SO) | 查看备注 |
群集共享卷文件系统 (CSV) | 是 |
弹性文件系统 (ReFS) | 是 |
请注意,如果对已打开的备用数据流的文件执行,则带取代处置的 CreateFile 将失败。
符号链接行为
如果对此函数的调用创建了一个文件,则行为没有变化。 此外,请考虑有关 FILE_FLAG_OPEN_REPARSE_POINT的以下信息:-
如果指定 了FILE_FLAG_OPEN_REPARSE_POINT :
- 如果打开现有文件并且它是符号链接,则返回的句柄是符号链接的句柄。
- 如果指定 了TRUNCATE_EXISTING 或 FILE_FLAG_DELETE_ON_CLOSE ,则受影响的文件是符号链接。
-
如果未指定 FILE_FLAG_OPEN_REPARSE_POINT :
- 如果打开现有文件并且它是符号链接,则返回的句柄是目标的句柄。
- 如果指定 CREATE_ALWAYS、TRUNCATE_EXISTING 或 FILE_FLAG_DELETE_ON_CLOSE,则受影响的文件是目标。
缓存行为
CreateFile 使用 dwFlagsAndAttributes 参数的多个可能值来控制或影响系统缓存与句柄关联的数据的方式。 它们分别是:- FILE_FLAG_NO_BUFFERING
- FILE_FLAG_RANDOM_ACCESS
- FILE_FLAG_SEQUENTIAL_SCAN
- FILE_FLAG_WRITE_THROUGH
- FILE_ATTRIBUTE_TEMPORARY
其中一些标志不应组合使用。 例如,将 FILE_FLAG_RANDOM_ACCESS 与 FILE_FLAG_SEQUENTIAL_SCAN 相结合是自败的。
指定 FILE_FLAG_SEQUENTIAL_SCAN 标志可以提高使用顺序访问读取大型文件的应用程序的性能。 对于主要按顺序读取大型文件,但偶尔在较小的字节范围内向前跳过的应用程序,性能提升可能更加明显。 如果应用程序移动文件指针进行随机访问,则很可能不会出现最佳缓存性能。 但是,仍能保证正确的操作。
标志FILE_FLAG_WRITE_THROUGH和FILE_FLAG_NO_BUFFERING是独立的,可以组合使用。
如果使用 FILE_FLAG_WRITE_THROUGH 但未同时指定 FILE_FLAG_NO_BUFFERING ,则系统缓存生效,则数据将写入系统缓存,但会立即刷新到磁盘。
如果 同时指定了FILE_FLAG_WRITE_THROUGH 和 FILE_FLAG_NO_BUFFERING ,则系统缓存无效,则数据会立即刷新到磁盘,而无需通过 Windows 系统缓存。 操作系统还会请求将硬盘的本地硬件缓存写入永久性媒体。
通过 FILE_FLAG_WRITE_THROUGH 的写通请求还会导致 NTFS 刷新处理请求导致的任何元数据更改,例如时间戳更新或重命名操作。 因此, FILE_FLAG_WRITE_THROUGH 标志通常与 FILE_FLAG_NO_BUFFERING 标志一起使用,作为每次写入后调用 FlushFileBuffers 函数的替代,这可能会导致不必要的性能损失。 将这些标志一起使用可避免这些处罚。 有关文件和元数据缓存的常规信息,请参阅 文件缓存。
当FILE_FLAG_NO_BUFFERING与FILE_FLAG_OVERLAPPED结合使用时,标志会提供最大的异步性能,因为 I/O 不依赖于内存管理器的同步操作。 但是,某些 I/O 操作需要更多时间,因为数据不会保留在缓存中。 此外,文件元数据仍可能缓存 (例如,在创建空文件时) 。 若要确保元数据刷新到磁盘,请使用 FlushFileBuffers 函数。
如果有足够的缓存内存可用,则指定 FILE_ATTRIBUTE_TEMPORARY 属性会导致文件系统避免将数据写回到大容量存储,因为应用程序在关闭句柄后会删除临时文件。 在这种情况下,系统可以完全避免写入数据。 尽管它不会像前面提到的标志那样直接控制数据缓存, 但 FILE_ATTRIBUTE_TEMPORARY 属性确实会告知系统在不写入的情况下尽可能多地保留系统缓存,因此某些应用程序可能很关注。
文件
如果重命名或删除文件,然后在不久之后还原它,系统会在缓存中搜索要还原的文件信息。 缓存信息包括其短/长名称对和创建时间。如果对由于对 DeleteFile 的上一次调用而挂起删除的文件调用 CreateFile,则函数将失败。 操作系统会延迟文件删除,直到文件的所有句柄关闭。 GetLastError 返回 ERROR_ACCESS_DENIED。
dwDesiredAccess 参数可以为零,这样,如果应用程序正在运行且具有足够安全设置,则应用程序无需访问文件即可查询文件属性。 这对于测试文件是否存在而不打开文件进行读取和/或写入访问,或者获取有关文件或目录的其他统计信息非常有用。 请参阅 获取和设置文件信息 和 GetFileInformationByHandle。
如果指定 了CREATE_ALWAYS 和 FILE_ATTRIBUTE_NORMAL , 则 CreateFile 将失败,并将最后一个错误设置为 ERROR_ACCESS_DENIED (如果该文件存在并且具有 FILE_ATTRIBUTE_HIDDEN 或 FILE_ATTRIBUTE_SYSTEM 属性)。 若要避免此错误,请指定与现有文件相同的属性。
当应用程序通过网络创建文件时, GENERIC_READ | GENERIC_WRITE
最好将 用于 dwDesiredAccess ,而不是单独使用 GENERIC_WRITE 。 生成的代码速度更快,因为重定向程序可以使用缓存管理器,并发送较少具有更多数据的 SMB。
此组合还避免了通过网络写入文件有时会返回 ERROR_ACCESS_DENIED的问题。
有关详细信息,请参阅创建和打开文件。
同步和异步 I/O 句柄
CreateFile 提供用于创建同步或异步的文件或设备句柄。 同步句柄的行为使使用该句柄的 I/O 函数调用被阻止,直到它们完成,而异步文件句柄使系统能够立即从 I/O 函数调用返回,无论它们是否完成了 I/O 操作。 如前所述,此同步与异步行为是通过在 dwFlagsAndAttributes 参数中指定FILE_FLAG_OVERLAPPED来确定的。 使用异步 I/O 时,存在一些复杂性和潜在缺陷:有关详细信息,请参阅 同步和异步 I/O。文件流
在 NTFS 文件系统上,可以使用 CreateFile 在文件中创建单独的流。 有关详细信息,请参阅 文件流。目录
应用程序无法使用 CreateFile 创建目录,因此对于此用例,只有 OPEN_EXISTING 值对 dwCreationDisposition 有效。 若要创建目录,应用程序必须调用 CreateDirectory 或 CreateDirectoryEx。若要使用 CreateFile 打开目录,请将 FILE_FLAG_BACKUP_SEMANTICS 标志指定为 dwFlagsAndAttributes 的一部分。 在没有 SE_BACKUP_NAME 和 SE_RESTORE_NAME 权限的情况下使用此标志时,仍适用适当的安全检查。
在对 FAT 或 FAT32 文件系统卷进行碎片整理期间使用 CreateFile 打开目录时,请勿指定 MAXIMUM_ALLOWED 访问权限。 如果这样做,将拒绝对目录的访问。 请改为指定 GENERIC_READ 访问权限。
有关详细信息,请参阅 关于目录管理。
物理磁盘和卷
对磁盘或卷的直接访问受到限制。Windows Server 2003 和 Windows XP: 以这种方式不限制对磁盘或卷的直接访问。
可以使用 CreateFile 函数打开物理磁盘驱动器或卷,这将返回直接访问存储设备 (DASD) 句柄,该句柄可与 DeviceIoControl 函数一起使用。 这使你能够直接访问磁盘或卷,例如分区表等磁盘元数据。 但是,这种类型的访问也会使磁盘驱动器或卷丢失数据,因为使用此机制对磁盘进行不正确的写入可能会导致操作系统无法访问其内容。 若要确保数据完整性,请务必熟悉 DeviceIoControl ,以及其他 API 与直接访问句柄(而不是文件系统句柄)的行为方式不同。
必须满足以下要求,此类调用才能成功:
- 调用方必须具有管理权限。 有关详细信息,请参阅使用特殊特权运行。
- dwCreationDisposition 参数必须具有 OPEN_EXISTING 标志。
- 打开卷或软盘时, dwShareMode 参数必须具有 FILE_SHARE_WRITE 标志。
String | 含义 |
---|---|
“\\.\PhysicalDrive0” | 打开第一个物理驱动器。 |
“\\.\PhysicalDrive2” | 打开第三个物理驱动器。 |
若要获取卷的物理驱动器标识符,请打开卷的句柄,并使用 IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS 调用 DeviceIoControl 函数。 此控制代码返回每个卷的一个或多个盘区的磁盘编号和偏移量;卷可以跨多个物理磁盘。
有关打开物理驱动器的示例,请参阅 调用 DeviceIoControl。
例如,打开卷或可移动媒体驱动器 (软盘驱动器或闪存 U 盘驱动器) 时, lpFileName 字符串应采用以下格式:“\.\X:”。 请勿使用指示驱动器根目录的尾部反斜杠 (\) 。 下表显示了驱动器字符串的一些示例。
String | 含义 |
---|---|
“\\.\A:” | 打开软盘驱动器 A。 |
“\\.\C:” | 打开 C: 卷。 |
“\.\C:\” | 打开 C: 卷的文件系统。 |
还可以通过引用卷名称来打开卷。 有关详细信息,请参阅 命名卷。
卷包含一个或多个已装载的文件系统。 即使 CreateFile 中未指定非缓存选项,也可以根据特定文件系统的判断将卷句柄作为非缓存打开。 应假定所有 Microsoft 文件系统都以非缓存状态打开卷句柄。 对文件的非缓存 I/O 的限制也适用于卷。
即使数据未缓存,文件系统也可能不需要缓冲区对齐。 但是,如果在打开卷时指定了非缓存选项,则无论卷上的文件系统如何,都会强制实施缓冲区对齐。 建议在所有文件系统上以非缓存方式打开卷句柄,并遵循非缓存 I/O 限制。
更换设备
DeviceIoControl的 IOCTL_CHANGER_* 控制代码接受变更器设备的句柄。 若要打开更换设备,请使用以下格式的文件名:“\\.\Changerx”,其中 x 是指示要打开的设备的数字,从零开始。 若要在用 C 或 C++ 编写的应用程序中打开变更器设备零,请使用以下文件名:“\\.\Changer0”。磁带驱动器
可以使用以下格式的文件名打开磁带驱动器:“\.\TAPEx”,其中 x 是指示要打开的驱动器的数字,从磁带驱动器零开始。 若要在用 C 或 C++ 编写的应用程序中打开磁带驱动器零,请使用以下文件名:“\\.\TAPE0”。有关详细信息,请参阅 备份。
通信资源
CreateFile 函数可以创建通信资源的句柄,例如串行端口 COM1。 对于通信资源,dwCreationDisposition 参数必须为OPEN_EXISTING,dwShareMode 参数必须为零 (独占访问 ) ,hTemplateFile 参数必须为 NULL。 可以指定读取、写入或读/写访问权限,并且可以为重叠 I/O 打开句柄。若要指定大于 9 的 COM 端口号,请使用以下语法:“\\.\COM10”。 此语法适用于所有允许指定 COM 端口号的端口号和硬件。
有关通信的详细信息,请参阅 通信。
机
CreateFile 函数可以创建控制台输入 (CONIN$) 句柄。 如果进程由于继承或重复而具有打开的句柄,则它还可以创建活动屏幕缓冲区的句柄 (CONOUT$) 。 调用进程必须附加到继承的控制台或 AllocConsole 函数分配的控制台。 对于控制台句柄,请按如下所示设置 CreateFile 参数。参数 | 值 |
---|---|
lpFileName |
使用 CONIN$ 值指定控制台输入。
使用 CONOUT$ 值指定控制台输出。 CONIN$ 获取控制台输入缓冲区的句柄,即使 SetStdHandle 函数重定向标准输入句柄也是如此。 若要获取标准输入句柄,请使用 GetStdHandle 函数。 CONOUT$ 获取活动屏幕缓冲区的句柄,即使 SetStdHandle 重定向标准输出句柄也是如此。 若要获取标准输出句柄,请使用 GetStdHandle。 |
dwDesiredAccess |
GENERIC_READ | GENERIC_WRITE 首选,但两者都可以限制访问。
|
dwShareMode |
打开 CONIN$时,请指定 FILE_SHARE_READ。 打开 CONOUT$时,请指定 FILE_SHARE_WRITE。
如果调用进程继承控制台,或者子进程应能够访问控制台,则此参数必须为 |
lpSecurityAttributes | 如果希望继承主机,SECURITY_ATTRIBUTES结构的bInheritHandle 成员必须为 TRUE。 |
dwCreationDisposition | 使用 CreateFile 打开控制台时,应指定OPEN_EXISTING。 |
dwFlagsAndAttributes | 已忽略。 |
hTemplateFile | 已忽略。 |
下表显示了 dwDesiredAccess 和 lpFileName 的各种设置。
lpFileName | dwDesiredAccess | 结果 |
---|---|---|
“CON” | GENERIC_READ | 打开控制台进行输入。 |
“CON” | GENERIC_WRITE | 打开控制台进行输出。 |
“CON” | GENERIC_READ | GENERIC_WRITE |
导致 CreateFile 失败; GetLastError 返回 ERROR_FILE_NOT_FOUND。 |
Mailslots
如果 CreateFile 打开 mailslot 的客户端端,则如果 mailslot 客户端在 mailslot 服务器使用 CreateMailSlot 函数创建本地 mailslot 之前尝试打开本地 mailslot,则函数将返回INVALID_HANDLE_VALUE。有关详细信息,请参阅 Mailslots。
管道
如果 CreateFile 打开命名管道的客户端端,该函数将使用处于侦听状态的命名管道的任何实例。 打开进程可以根据需要多次复制句柄,但在打开该句柄后,其他客户端无法打开命名管道实例。 打开管道时指定的访问必须与 CreateNamedPipe 函数的 dwOpenMode 参数中指定的访问兼容。如果在此操作之前未在服务器上成功调用 CreateNamedPipe 函数,则管道将不存在, 并且 CreateFile 将失败并 ERROR_FILE_NOT_FOUND。
如果至少有一个活动管道实例,但服务器上没有可用的侦听器管道,这意味着当前已连接所有管道实例, 则 CreateFile 将失败 并ERROR_PIPE_BUSY。
有关详细信息,请参阅 管道。
示例
以下主题中显示了示例文件操作:
- 将一个文件追加到另一个文件
- 取消挂起的 I/O 操作
- 使用重定向输入和输出创建子进程
- 创建和使用临时文件
- FSCTL_RECALL_FILE
- GetFinalPathNameByHandle
- 锁定和解锁文件中的字节范围
- 从文件句柄获取文件名
- 获取文件系统识别信息
- 打开文件进行读取或写入
- 检索 Last-Write 时间
- SetFileInformationByHandle
- 测试文件末尾
- 使用光纤
- 使用流
- 遍历更改日志记录的缓冲区
- Wow64DisableWow64FsRedirection
- Wow64EnableWow64FsRedirection
使用 mailslot 显示在 写入 Mailslot 中。
可以在 创建备份应用程序中找到磁带备份代码片段。
注意
fileapi.h 标头将 CreateFile 定义为别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名的使用与非非特定编码的代码混合使用可能会导致不匹配,从而导致编译或运行时错误。 有关详细信息,请参阅 函数原型的约定。
要求
最低受支持的客户端 | Windows XP [仅限桌面应用] |
最低受支持的服务器 | Windows Server 2003 [仅限桌面应用] |
目标平台 | Windows |
标头 | fileapi.h (包括 Windows.h) |
Library | Kernel32.lib |
DLL | Kernel32.dll |
另请参阅
函数
概述主题
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈