SetFilePointer() -- 设置文件指针

beyes

SetFilePointer() 函数用来移动文件指针，它和 Unix 中的 lseek() 函数以及 C 库中的 fseek() 函数是类似的。该函数原型声明如下：

[Plain Text] 纯文本查看 复制代码

DWORD WINAPI SetFilePointer(
  __in         HANDLE hFile,
  __in         LONG lDistanceToMove,
  __inout_opt  PLONG lpDistanceToMoveHigh,
  __in         DWORD dwMoveMethod
);

第 1 个参数为要操作的文件句柄；

第 2 个参数是一个 32 位有符号 LONG 型( 32 位系统平台)，它代表要移动的距离；

第 3 个参数是指向移动距离值的高序部分，如果这个值设置为 NULL，那么函数只能对长度限制在 (2^31 - 1) 之内的文件进行操作 ，因为这个是有符号的 LONG 型。如果该值非 NULL，那么 lpDistanceToMoveHigh 和 lDistanceToMove 合起来就能进行 64 位有符号的移动，而此时这个参数还用于接收文件指针的高序位返回值，而低序位部分由函数的返回值返回。

如果函数返回值不为  INVALID_SET_FILE_POINTER (-1) ，那么说明函数是执行成功的，这时就无需再调用 GetLastError() 函数进行检查。

然而需要注意的是，INVALID_SET_FILE_POINTER 对于低序位部分是个有效值。也就是说，当设定了lpDistanceToMoveHigh 时，低序位可以寻址到 0xFFFFFFFF 这里，如果函数执行成功那么返回值是 -1，这时因为函数的返回既代表了文件位置又代表了错误代码，所以还需要用 GetLastError() 来确认一下是不是确实发生了错误，如果没有错误那么会返回 NO_ERROR ，若发生了错误，那么返回值就不是位置，而是一个  INVALID_SET_FILE_POINTER 。因此一般情况下，这时会将文件的长度单位限制在 (2^32 - 2) ，这样就避开了要调用 GetLastError() 的必要。

在操作巨型文件时才需要设置第 3 个参数，但是使用 SetFilePointer() 函数来操作巨型文件会显得有些笨拙，对于这种情况可以选择它的增强型 SetFilePointerEx() 则更加容易。

第 4 个参数是移动模式，一共有 3 种：
FILE_BEGIN : 从文件开始的位置进行定位，此时 lDistanceToMove 被解释为无符号型。
FILE_CURRENT : 从文件的当前位置向前或向后移动指针， lDistanceToMove 被解释为有符号型，正数代表向前，负数表示向后。
FILE_END : 从文件的末位向前或向后定位指针。

另外，通过制定从文件尾进行长度为 0 的移动，可以获得文件长度，这个长度值通过函数的返回值可知。

示例程序：

[C++] 纯文本查看 复制代码

#include "stdafx.h"


int _tmain(int argc, _TCHAR* argv[])
{
    _tsetlocale(LC_CTYPE, _T(""));
    HANDLE hFile;
    CHAR buffer[256] = {};
    DWORD nByte;


    hFile = CreateFile(_T("a.txt"), GENERIC_READ, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL); 
    ReadFile(hFile, buffer, 256, &nByte, NULL);
    buffer[nByte] = '\0';
    _ftprintf(stdout, _T("a.txt 中的原始字符串: %S"), buffer);

    SetFilePointer(hFile, 6, NULL, FILE_BEGIN);
    
    ReadFile(hFile, buffer, 7, &nByte, NULL);
    buffer[nByte] = '\0';
    _ftprintf(stdout, _T("\n从开头偏移 6 个字符调整后读：%S"), buffer);
     
    SetFilePointer(hFile, 8, NULL, FILE_CURRENT);
    ReadFile(hFile, buffer, 7, &nByte, NULL);
    buffer[nByte] = '\0';
    _ftprintf(stdout, _T("\n\n从当前位置偏移 8 个字符调整后读：%S"), buffer);

    _ftprintf(stdout, _T("\n\n文件总大小为:%d\n"), SetFilePointer(hFile, 0, NULL, FILE_END));    //从文件末尾移动 0 个字节以得到文件的长度


    CloseHandle(hFile);

    return 0;
}

运行输出：

D:\WindowsAPP\setfp\Debug>setfp.exe
a.txt 中的原始字符串: hello windows system programming

从开头偏移 6 个字符调整后读：windows

从当前位置偏移 8 个字符调整后读：program

文件总大小为:35

查看 a.txt 文件的大小：

D:\WindowsAPP\setfp\Debug>dir a.txt
驱动器 D 中的卷是 WinSoft
卷的序列号是 6EAB-3C0C

D:\WindowsAPP\setfp\Debug 的目录

2011/09/12  23:59                35 a.txt
               1 个文件             35 字节
               0 个目录 133,821,374,464 可用字节