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 a certain position within a stream.

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

Method Summary

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

getPosition returns the current offset of the stream.

getLength returns the length of the stream.

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 or after the end of the stream.

Throws

com::sun::star::lang::IllegalArgumentException in case location is negative or greater than XSeekable::getLength .

getPosition

Syntax

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

Description

returns the current offset of the stream.

Returns

the current offset in this stream.

getLength

Syntax

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

Description

returns the length of the stream.

Returns

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