SolFSStream.Seek method
Filter:
Pascal DLL C++ (DLL/Lib) C++ (VCL) C++ (.NET) C# VB.NETOverview
Moves to a specified position in the stream for which it was invoked.
Declaration
[Pascal]
function Seek(Offset: LongInt; Origin: Word): LongInt;
function SeekEx(Offset: Int64; Origin: Word): Int64;
[DLL]
long _stdcall StorageSeekFile(unsigned long File, long Offset,
unsigned short Origin, long *Position);
long _stdcall StorageSeekFileLong(unsigned long File, long long Offset,
unsigned short Origin, unsigned long long *Position);
[C++ (DLL/Lib)]
virtual unsigned long long Seek(long long Offset, SeekOrigin Origin)
[C++ (VCL)]
virtual long __fastcall Seek(long Offset, Word Origin)
virtual long long __fastcall SeekEx(long long Offset, Word Origin)
[C++ (.NET)]
__int64 Seek(__int64 offset, SeekOrigin origin)
[C#]
long Seek(long offset, SeekOrigin origin)
[VB.NET]
Function Seek(offset As Long, origin As SeekOrigin) As Long
Parameters
- Offset - offset of the posision. Its value depends on Origin parameter.
- Origin - indicates how to interpret the Offset parameter. Origin should be one of the following values:
- [DLL] File - handle to the file returned by Create function.
- [DLL] Position - returns the new value of the position.
Values of Origin
[Pascal] [DLL] [C++ (VCL)]
[.NET]
Meaning
soFromBeginning
Begin
Offset is from the beginning of the resource. Seek moves to the position Offset. Offset must be >= 0.
soFromCurrent
Current
Offset is from the current position in the resource. Seek moves to Position + Offset.
soFromEnd
End
Offset is from the end of the resource. Offset must be <= 0 to indicate a number of bytes before the end of the file.
Return value
The new value of the Position. [DLL] 0 if the function succeeded or one of Error codes if the function failed.
Description
Call Seek to change current position in the stream.