Get document position
Get document position ( docRef : Time ) : Real
| Parameter | Type | Description | |
|---|---|---|---|
| docRef | Time | → | Document reference number |
| Function result | Real | ← | File position (expressed in bytes) from the beginning of the file |
History
| Release | Changes |
|---|---|
| 6 | Created |
Description
Get document position returns the position, starting from the beginning of the document, where the next read (RECEIVE PACKET) or write (SEND PACKET) will occur.
This command operates only on a document that is currently open whose document reference number you pass in docRef.
See also
RECEIVE PACKET
SEND PACKET
SET DOCUMENT POSITION
Properties
| Command number | 481 |
| Thread safe | yes |