MFS CHGFILEPTR: Difference between revisions
Created page with "Move the file's logical read position pointer. ==Syntax== int far pascal MFS_CHGFILEPTR(offset, type) ==Parameters== offset is the signed offset which depending on the typ..." |
mNo edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
Move the file's logical read position pointer. | {{DISPLAYTITLE:MFS_CHGFILEPTR}} | ||
Move the file's logical read position pointer. | |||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 6: | ||
==Parameters== | ==Parameters== | ||
offset is the signed offset which depending on the type parameter is used to determine the new position within the file. | ;offset:is the signed offset which depending on the type parameter is used to determine the new position within the file. | ||
type indicates the basis of a seek operation. | ;type:indicates the basis of a seek operation. | ||
::0 indicates seek relative to beginning of file. | |||
::1 indicates seek relative to current position within the file. | |||
::2 indicates seek relative to end of file. | |||
==Returns== | ==Returns== | ||
0 : If no error is detected, a zero error code is returned. | ;0: If no error is detected, a zero error code is returned. | ||
non-zero :If an error is detected, a non-zero error code is returned. | ;non-zero:If an error is detected, a non-zero error code is returned. | ||
==Remarks== | ==Remarks== | ||
The file system may want to take the seek operation as a hint that an I/O operation is about to take place at the new position and initiate a | The file system may want to take the seek operation as a hint that an I/O operation is about to take place at the new position and initiate a positioning operation on sequential access media or read-ahead operation on other media. | ||
== | ==Calling Sequence== | ||
<PRE> | <PRE> | ||
int far pascal MFS_CHGFILEPTR(offset, type) | int far pascal MFS_CHGFILEPTR(offset, type) | ||
| Line 27: | Line 27: | ||
</PRE> | </PRE> | ||
[[Category:IFS]] | [[Category:IFS Interfaces]] | ||
Latest revision as of 05:42, 17 February 2020
Move the file's logical read position pointer.
Syntax
int far pascal MFS_CHGFILEPTR(offset, type)
Parameters
- offset
- is the signed offset which depending on the type parameter is used to determine the new position within the file.
- type
- indicates the basis of a seek operation.
- 0 indicates seek relative to beginning of file.
- 1 indicates seek relative to current position within the file.
- 2 indicates seek relative to end of file.
Returns
- 0
- If no error is detected, a zero error code is returned.
- non-zero
- If an error is detected, a non-zero error code is returned.
Remarks
The file system may want to take the seek operation as a hint that an I/O operation is about to take place at the new position and initiate a positioning operation on sequential access media or read-ahead operation on other media.
Calling Sequence
int far pascal MFS_CHGFILEPTR(offset, type) long offset; unsigned short type;