文件对象 [AHK_L 42+]

Read

从文件读取字符串, 并使文件指针向后移动.

String := File.Read(Characters)

参数

Characters

如果省略, 则读取文件的剩余部分并作为单个字符串返回. 如果为空, 则默认为 0. 否则, 请指定需读取的最大字符数. 如果 File 对象创建于非搜寻设备(例如控制台缓冲区或管道) 的句柄, 省略此参数可能引起执行方法失败或仅返回当前可用的数据.

返回值/h4>

此方法返回所读取的字符串.

Write

写入字符串到文件, 并使文件指针向后移动.

BytesWritten := File.Write(String)

参数

String

要写入的字符串.

返回值

此方法返回写入的字节数(不是字符数).

ReadLine

从文件中读取一行文本, 并使文件指针向后移动.

TextLine := File.ReadLine()

返回值

此方法返回一行文本. 其中可能包括 `n, `r`n 或 `r 这取决于文件和打开文件时使用的 EOL 标志.

备注

可以读取长达 65,534 个字符的行. 如果一个行的长度超过这个长度, 则该行的其余部分将通过对此方法的后续调用返回.

WriteLine

将一行文本写入文件, 并向后移动文件指针.

BytesWritten := File.WriteLine(String)

参数

String

如果为空或省略, 则写入空行. 否则, 请指定要写入的字符串, 根据打开文件时使用的 EOL 标志, 字符串后面总是跟着 `n 或 `r`n.

返回值

此方法返回写入的字节数(不是字符数).

ReadNumType

从文件中读取指定类型的数据, 并使文件指针向后移动.

Num := File.ReadNumType()

NumType 可以是 UInt, Int, Int64, Short, UShort, Char, UChar, Double 或 Float. 这些类型名称与 DllCall() 具有相同的含义.

返回值

如果成功, 方法返回数字, 如果失败, 则返回空字符串.

备注

如果使用 Try 语句且没有读取任何字节时将抛出异常. 但是, 如果读取到任何字节则不会抛出异常, 即使 NumType 的设定值大于读取的字节数. 不足位用 0 填充.

WriteNumType

写入指定类型的数据到文件, 并使文件指针向后移动.

BytesWritten := File.WriteNumType(Num)

NumType 可以是 UInt, Int, Int64, Short, UShort, Char, UChar, Double 或 Float. 这些类型名称与 DllCall() 中的具有相同的含义.

参数

Num

写入的数字.

返回值

此方法返回写入的字节数. 例如, 写入成功时 File.WriteUInt(42) 返回 4.

RawRead

从文件读取原始的二进制数据到内存, 并使文件指针向后移动.

BytesRead := File.RawRead(VarOrAddress, Bytes)

参数

VarOrAddress

用来保存复制出来的数据的变量或内存地址. 用法类似于 NumGet.

Bytes

需读取的最大字节数.

返回值

此方法返回读取的字节数.

备注

如果使用 Try 语句, 且 Bytes 不为零, 但是没有读取到字节, 则抛出异常. 如果有需要, 可使用 AtEOF 属性来避免这种情况.

RawWrite

写入原始的二进制数据到文件, 并使文件指针向后移动.

BytesWritten := File.RawWrite(VarOrAddress, Bytes)

参数

VarOrAddress

包含数据的变量或内存中的数据地址. 用法类似于 NumPut(). 如果指定了变量, 则必要时会自动扩展.

Bytes

需写入的字节数.

返回值

此方法返回写入的字节数.

Seek

移动文件指针.

IsMoved := File.Seek(Distance , Origin)

参数

Distance

需移动的距离, 单位为字节. 较小的值更接近文件的开始处.

Origin

如果省略, 当 Distance 为负数时, 默认为 2, 其他情况, 为 0. 否则, 请指定以下数字之一, 以指示文件指针开始移动的起点:

• 0(SEEK_SET): 文件的开始处. Distance 必须为零或更大.
• 1(SEEK_CUR): 文件指针的当前位置.
• 2(SEEK_END): 文件的末尾. Distance 通常应该为负数.

返回值

成功时, 此方法返回 1(true), 失败时返回 0(false).

备注

如果 Distance 不是负数, 并且 Origin 省略或为 0(SEEK_SET) 时, 此方法等同于 File.Pos := Distance 和 File.Position := Distance.

Tell

返回文件指针的当前位置, 其中 0 是文件的开始.

CurrentPos := File.Tell()

此方法等同于 CurrentPos := File.Pos 和 CurrentPos := File.Position.

Close

关闭文件, 把缓冲区的数据写入磁盘并释放共享锁定.

File.Close()

尽管当对象释放时文件会自动关闭, 不过建议尽快关闭文件.

Pos / Position

检索或设置文件指针的位置.

CurrentPos := File.Pos
CurrentPos := File.Position

File.Pos := NewPos
File.Position := NewPos

CurrentPos 和 NewPos 是从文件开始的字节偏移量, 其中 0 是第一个字节. 当向文件写入数据或从文件中读取数据时, 文件指针自动移动到该数据之后的下一个字节.

此方法等同于 CurrentPos := File.Tell() 和 File.Seek(NewPos).

Length

获取或设置文件的大小.

CurrentSize := File.Length

File.Length := NewSize

CurrentSize 和 NewSize 是文件的大小, 单位为字节.

此属性应该仅用于真实的文件. 如果 File 对象创建于管道的句柄, 那么它可能返回管道内部缓冲区中当前可能数据的数目, 但不能保证一定如此.

AtEOF

当文件指针到达文件末尾时, 返回非零数字, 否则为零.

IsAtEOF := File.AtEOF

此属性应该仅用于真实的文件. 如果 File 对象创建于非搜寻设备(例如控制台缓冲区或管道) 的句柄, 那么返回的值可能没有意义, 因为这些设备逻辑上没有 "文件末尾".

Encoding

获取或设置此文件对象使用的编码.

CurrentEncoding := File.Encoding

File.Encoding := NewEncoding

CurrentEncoding 和 NewEncoding 是一个代表代码页标识符的数字(请参阅 Microsoft Docs) 或以下字符串之一:

• UTF-8: Unicode UTF-8, 相当于 CP65001.
• UTF-16: 带小端字节顺序标识的 Unicode UTF-16 等效于 CP1200.
• CPnnn: 带数字的标识符 nnn 的代码页.

CurrentEncoding 不会返回带 -RAW 后缀的值, 不论文件如何被打开或是否包含字节顺序标识(BOM). 设置 NewEncoding 不会增加或移除 BOM, 因为 BOM 通常在文件建立时就被写入其中.

[v1.1.15.04+]: 设置 NewEncoding 为 UTF-8-RAW 或 UTF-16-RAW 合法, 但 -RAW 后缀将被忽略. 而之前的版本中, UTF-8-RAW 及 UTF-16-RAW 如同非法的 8 位编码, 导致所有非 ASCII 字符被丢弃, 不过这只会影响 File.Encoding, 而不会影响 FileOpen().

Handle / __Handle

检索用于 DllCall() 的系统文件句柄. 请参阅 CreateFile.

Handle := File.Handle  ; 需要 [v1.1.35+]
Handle := File.__Handle

文件对象使用内部缓冲区读取或写入. 如果数据已经被写入对象的内部缓冲区, 则在返回句柄前会确保把数据写入磁盘. 如果缓冲区中包含从文件读取的数据, 则会把数据丢弃, 并将文件指针的实际位置重设为 Pos 属性表示的逻辑位置.