xref: /trunk/main/udkapi/com/sun/star/io/XSeekable.idl (revision 408a4873)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_io_XSeekable_idl__
#define __com_sun_star_io_XSeekable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module io {

//=============================================================================

// DocMerge from xml: interface com::sun::star::io::XSeekable
/** makes it possible to seek to a certain position within a stream.

	<p>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.
 */
published interface XSeekable: com::sun::star::uno::XInterface
{

	// DocMerge from xml: method com::sun::star::io::XSeekable::seek
	/** changes the seek pointer to a new location relative to the beginning of the stream.


		<p> 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. </p>

        @throws com::sun::star::lang::IllegalArgumentException in case location is negative or greater than <member>XSeekable::getLength</member>.
	 */
	void seek( [in] hyper location )
		raises( com::sun::star::lang::IllegalArgumentException, com::sun::star::io::IOException );


	// DocMerge from xml: method com::sun::star::io::XSeekable::getPosition
	/** returns the current offset of the stream.
       @returns
			 the current offset in this stream.
	 */
	hyper getPosition()
		raises( com::sun::star::io::IOException );


	// DocMerge from xml: method com::sun::star::io::XSeekable::getLength
	/** returns the length of the stream.
       @returns
			the length of the storage medium on which the stream works.
	 */
	hyper getLength()
		raises( com::sun::star::io::IOException );
};

//=============================================================================

}; }; }; };
#endif