interface XSeekable in module com::sun::star::io::

(Global Index)

Syntax

interface XSeekable : com::sun::star::uno::XInterface ;

Description

makes it possible to seek to certain position within a stream.

This interface should be supported if it is possible to access the data at the new position fast. For example the access to a file should be fast enough. You should not support this interface, for example, if you have a continuous stream like a video stream.

Method Summary

seek changes the seek pointer to a new location relative to the beginning of the stream.

getPosition

getLength

Method Details



seek

Syntax

void seek (
hyper location )
raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::io::IOException );

Description

changes the seek pointer to a new location relative to the beginning of the stream.

This method changes the seek pointer so subsequent reads and writes can take place at a different location in the stream object. It is an error to seek before the beginning of the stream. However, it is not an error to seek past the end of the stream. Seeking past the end of the stream is useful for subsequent writes, as the stream will at that time be extended to the seek position immediately before the write is done.


getPosition

Syntax

hyper getPosition ();
raises ( com::sun::star::io::IOException );

Description

Returns

the current offset in this stream.

getLength

Syntax

hyper getLength ();
raises ( com::sun::star::io::IOException );

Description

Returns

the length of the storage medium on which the stream works.
Top of Page