Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » ucb

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: ucb ::

interface XSimpleFileAccess

Description This is the basic interface to read data from a stream.

---

Methods' Summary
copy	Copies a file
move	Moves a file
kill	Removes a file. If the URL represents a folder, the folder will be removed, even if it's not empty.
isFolder	Checks if an URL represents a folder
isReadOnly	Checks if a file is "read only"
setReadOnly	Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so.
createFolder	Creates a new Folder
getSize	Returns the size of a file.
getContentType	Returns the content type of a file.
getDateTimeModified	Returns the last modified date for the file
getFolderContents	Returns the contents of a folder
exists	Checks if a file exists
openFileRead	Opens file to read
openFileWrite	Opens file to write.
openFileReadWrite	Opens file to read and write
setInteractionHandler	Sets an interaction handler to be used for further operations.

Methods' Details

copy void copy( [in] string  SourceURL, [in] string  DestURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Copies a file Parameter SourceURL URL of the file to be copied Parameter DestURL URL of the location the file should be copied to See also move

move void move( [in] string  SourceURL, [in] string  DestURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Moves a file Parameter SourceURL URL of the file to be moved Parameter DestURL URL of the location the file should be moved to See also move

kill void kill( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Removes a file. If the URL represents a folder, the folder will be removed, even if it's not empty. Parameter FileURL File/folder to be removed See also move

isFolder boolean isFolder( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Checks if an URL represents a folder Parameter FileURL URL to be checked Returns true, if the given URL represents a folder, otherwise false

isReadOnly boolean isReadOnly( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Checks if a file is "read only" Parameter FileURL URL to be checked Returns true, if the given File is "read only", false otherwise

setReadOnly void setReadOnly( [in] string  FileURL, [in] boolean  bReadOnly ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so. Parameter bReadOnly true; "read only" flag will be set, false; "read only" flag will be reset

createFolder void createFolder( [in] string  NewFolderURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Creates a new Folder Parameter NewFolderURL URL describing the location of the new folder

getSize long getSize( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Returns the size of a file. Parameter FileURL URL of the file Returns Size of the file in bytes

getContentType string getContentType( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Returns the content type of a file. Parameter FileURL URL of the file Returns Content type of the file See also XContent::getContentType

getDateTimeModified ::com::sun::star::util::DateTime getDateTimeModified( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Returns the last modified date for the file Parameter FileURL URL of the file Returns Last modified date for the file

getFolderContents sequence< string > getFolderContents( [in] string  FolderURL, [in] boolean  bIncludeFolders ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Returns the contents of a folder Parameter FolderURL URL of the folder Parameter bIncludeFolders true: Subfolders are included, false: No subfolders Returns The content of a folder, each file as one string in a string sequence

exists boolean exists( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Checks if a file exists Parameter FileURL URL to be checked Returns true, if the File exists, false otherwise

openFileRead ::com::sun::star::io::XInputStream openFileRead( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Opens file to read Parameter FileURL File to open Returns An XInputStream, if the file can be opened for reading

openFileWrite ::com::sun::star::io::XOutputStream openFileWrite( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Opens file to write. Parameter FileURL File to open Returns An XOutputStream, if the file can be opened for writing Throws UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources XSimpleFileAccess2::writeFile may be used.

openFileReadWrite ::com::sun::star::io::XStream openFileReadWrite( [in] string  FileURL ) raises( CommandAbortedException, ::com::sun::star::uno::Exception ); Description Opens file to read and write Parameter FileURL File to open Returns An XStream, if the file can be opened for reading and writing Throws UnsupportedDataSinkException, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources XSimpleFileAccess2::writeFile may be used.

setInteractionHandler void setInteractionHandler( [in] ::com::sun::star::task::XInteractionHandler  Handler ); Description Sets an interaction handler to be used for further operations. A default interaction handler is available as service ::com::sun::star::task::InteractionHandler. The documentation of this service also contains further information about the interaction handler concept. Parameter Handler The interaction handler to be set See also ::com::sun::star::task::InteractionHandler

Top of Page

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.