DosChgFilePtr: Difference between revisions
Appearance
mNo edit summary |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This call moves the read/write pointer in accordance with the type of move specified. | This call moves the read/write pointer in accordance with the type of move specified. | ||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;FileHandle (HFILE) - input : Handle returned by a previous DosOpen call. | ;FileHandle ([[HFILE]]) - input : Handle returned by a previous DosOpen call. | ||
; Distance (LONG) - input : The offset to move, in bytes. | ;Distance (LONG) - input : The offset to move, in bytes. | ||
; MoveType (USHORT) - input : Method of moving. Specifies a location in the file from where Distance to move the read/write pointer starts. Values and their meanings are: | ;MoveType (USHORT) - input : Method of moving. Specifies a location in the file from where Distance to move the read/write pointer starts. Values and their meanings are: | ||
::0 - Beginning of the file. | |||
::1 - Current location of the read/write pointer. | |||
::2 - End of the file. Use this method to determine a file's size. | |||
;NewPointer (PULONG) - output : Address of the new pointer location. | |||
; NewPointer (PULONG) - output : Address of the new pointer location. | |||
==Return Code== | ==Return Code== | ||
;rc (USHORT) - return:Return code descriptions are: | |||
Return code descriptions are: | |||
* 0 NO_ERROR | * 0 NO_ERROR | ||
* 1 ERROR_INVALID_FUNCTION | * 1 ERROR_INVALID_FUNCTION | ||
* 6 ERROR_INVALID_HANDLE | * 6 ERROR_INVALID_HANDLE | ||
==Remarks== | ==Remarks== | ||
The read/write pointer in a file is a signed 32-bit number. A negative value moves the pointer backward in the file. A positive value moves the pointer forward. DosChgFilePtr cannot be used to seek to a negative position in the file. | The read/write pointer in a file is a signed 32-bit number. A negative value moves the pointer backward in the file. A positive value moves the pointer forward. DosChgFilePtr cannot be used to seek to a negative position in the file. | ||
This call may not be used for a character device or pipe. | This call may not be used for a character device or pipe. | ||
== | ==Bindings== | ||
===C | ===C=== | ||
<PRE> | <PRE> | ||
#define INCL_DOSFILEMGR | #define INCL_DOSFILEMGR | ||
| Line 35: | Line 31: | ||
USHORT rc = DosChgFilePtr(FileHandle, Distance, MoveType, NewPointer); | USHORT rc = DosChgFilePtr(FileHandle, Distance, MoveType, NewPointer); | ||
HFILE | HFILE FileHandle; /* File handle */ | ||
LONG | LONG Distance; /* Distance to move in bytes */ | ||
USHORT | USHORT MoveType; /* Method of moving (0, 1, 2) */ | ||
PULONG | PULONG NewPointer; /* New Pointer Location */ | ||
USHORT rc; /* return code */ | |||
</PRE> | |||
===MASM=== | |||
<PRE> | |||
EXTRN DosChgFilePtr:FAR | |||
INCL_DOSFILEMGR EQU 1 | |||
PUSH WORD FileHandle ;File handle | |||
PUSH DWORD Distance ;Distance to move in bytes | |||
PUSH WORD MoveType ;Method of moving (0, 1, 2) | |||
PUSH@ DWORD NewPointer ;New Pointer Location (returned) | |||
CALL DosChgFilePtr | |||
Returns WORD | |||
</PRE> | </PRE> | ||
==Example Code== | |||
This example opens file test.dat, writes some data, and resets the file pointer to the beginning of the file. | This example opens file test.dat, writes some data, and resets the file pointer to the beginning of the file. | ||
<PRE> | <PRE> | ||
| Line 77: | Line 89: | ||
FILE_SIZE, /* File primary allocation */ | FILE_SIZE, /* File primary allocation */ | ||
FILE_ATTRIBUTE, /* File attribute */ | FILE_ATTRIBUTE, /* File attribute */ | ||
FILE_EXISTS | FILE_NOEXISTS, | FILE_EXISTS | FILE_NOEXISTS, /* Open function type */ | ||
DASD_FLAG | INHERIT | | DASD_FLAG | INHERIT | /* Open mode of the file */ | ||
WRITE_THRU | FAIL_FLAG | | WRITE_THRU | FAIL_FLAG | | ||
SHARE_FLAG | ACCESS_FLAG, | SHARE_FLAG | ACCESS_FLAG, | ||
| Line 92: | Line 104: | ||
</PRE> | </PRE> | ||
[[Category:Dos16]] | |||
[[Category: | |||
Latest revision as of 01:47, 26 January 2020
This call moves the read/write pointer in accordance with the type of move specified.
Syntax
DosChgFilePtr (FileHandle, Distance, MoveType, NewPointer)
Parameters
- FileHandle (HFILE) - input
- Handle returned by a previous DosOpen call.
- Distance (LONG) - input
- The offset to move, in bytes.
- MoveType (USHORT) - input
- Method of moving. Specifies a location in the file from where Distance to move the read/write pointer starts. Values and their meanings are:
- 0 - Beginning of the file.
- 1 - Current location of the read/write pointer.
- 2 - End of the file. Use this method to determine a file's size.
- NewPointer (PULONG) - output
- Address of the new pointer location.
Return Code
- rc (USHORT) - return
- Return code descriptions are:
- 0 NO_ERROR
- 1 ERROR_INVALID_FUNCTION
- 6 ERROR_INVALID_HANDLE
Remarks
The read/write pointer in a file is a signed 32-bit number. A negative value moves the pointer backward in the file. A positive value moves the pointer forward. DosChgFilePtr cannot be used to seek to a negative position in the file.
This call may not be used for a character device or pipe.
Bindings
C
#define INCL_DOSFILEMGR USHORT rc = DosChgFilePtr(FileHandle, Distance, MoveType, NewPointer); HFILE FileHandle; /* File handle */ LONG Distance; /* Distance to move in bytes */ USHORT MoveType; /* Method of moving (0, 1, 2) */ PULONG NewPointer; /* New Pointer Location */ USHORT rc; /* return code */
MASM
EXTRN DosChgFilePtr:FAR INCL_DOSFILEMGR EQU 1 PUSH WORD FileHandle ;File handle PUSH DWORD Distance ;Distance to move in bytes PUSH WORD MoveType ;Method of moving (0, 1, 2) PUSH@ DWORD NewPointer ;New Pointer Location (returned) CALL DosChgFilePtr Returns WORD
Example Code
This example opens file test.dat, writes some data, and resets the file pointer to the beginning of the file.
#define INCL_DOSFILEMGR
#define OPEN_FILE 0x01
#define CREATE_FILE 0x10
#define FILE_ARCHIVE 0x20
#define FILE_EXISTS OPEN_FILE
#define FILE_NOEXISTS CREATE_FILE
#define DASD_FLAG 0
#define INHERIT 0x80
#define WRITE_THRU 0
#define FAIL_FLAG 0
#define SHARE_FLAG 0x10
#define ACCESS_FLAG 0x02
#define FILE_NAME "test.dat"
#define FILE_SIZE 800L
#define FILE_ATTRIBUTE FILE_ARCHIVE
#define RESERVED 0L
HFILE FileHandle;
USHORT Wrote;
USHORT Action;
PUSHORT Local
PSZ FileData[100];
USHORT rc;
Action = 2;
strcpy(FileData, "Data...");
if(!DosOpen(FILE_NAME, /* File path name */
&FileHandle, /* File handle */
&Action, /* Action taken */
FILE_SIZE, /* File primary allocation */
FILE_ATTRIBUTE, /* File attribute */
FILE_EXISTS | FILE_NOEXISTS, /* Open function type */
DASD_FLAG | INHERIT | /* Open mode of the file */
WRITE_THRU | FAIL_FLAG |
SHARE_FLAG | ACCESS_FLAG,
RESERVED)) /* Reserved (must be zero) */
if(!DosWrite(FileHandle, /* File handle */
(PVOID) FileData, /* User buffer */
sizeof(FileData), /* Buffer length */
&Wrote)) /* Bytes written */
rc = DosChgFilePtr(FileHandle, /* File handle */
MOVE_DIST, /* Distance to move in bytes */
FILE_BEG, /* Method of moving */
&Local); /* New pointer location */