This is the basic interface to read data from a stream. More...
import "XSimpleFileAccess.idl";
Public Member Functions | |
| void | copy ([in] string SourceURL, [in] string DestURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Copies a file. | |
| void | move ([in] string SourceURL, [in] string DestURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Moves a file. | |
| void | kill ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Removes a file. | |
| boolean | isFolder ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Checks if a URL represents a folder. | |
| boolean | isReadOnly ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Checks if a file is "read only". | |
| void | setReadOnly ([in] string FileURL, [in] boolean bReadOnly) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so. | |
| void | createFolder ([in] string NewFolderURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Creates a new Folder. | |
| long | getSize ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Returns the size of a file. | |
| string | getContentType ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Returns the content type of a file. | |
| ::com::sun::star::util::DateTime | getDateTimeModified ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Returns the last modified date for the file. | |
| sequence< string > | getFolderContents ([in] string FolderURL, [in] boolean bIncludeFolders) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Returns the contents of a folder. | |
| boolean | exists ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Checks if a file exists. | |
| com::sun::star::io::XInputStream | openFileRead ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Opens file to read. | |
| com::sun::star::io::XOutputStream | openFileWrite ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Opens file to write. | |
| com::sun::star::io::XStream | openFileReadWrite ([in] string FileURL) raises ( com::sun::star::ucb::CommandAbortedException, com::sun::star::uno::Exception ) |
| Opens file to read and write. | |
| void | setInteractionHandler ([in] com::sun::star::task::XInteractionHandler Handler) |
| Sets an interaction handler to be used for further operations. | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. | |
| void | acquire () |
| increases the reference counter by one. | |
| void | release () |
| decreases the reference counter by one. | |
This is the basic interface to read data from a stream.
| void copy | ( | [in] string | SourceURL, | |||
| [in] string | DestURL ) | |||||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Copies a file.
| SourceURL | URL of the file to be copied |
| DestURL | URL of the location the file should be copied to |
| void createFolder | ( | [in] string | NewFolderURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Creates a new Folder.
| NewFolderURL | URL describing the location of the new folder |
| boolean exists | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Checks if a file exists.
| FileURL | URL to be checked |
| string getContentType | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Returns the content type of a file.
| FileURL | URL of the file |
| ::com::sun::star::util::DateTime getDateTimeModified | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Returns the last modified date for the file.
| FileURL | URL of the file |
| sequence< string > getFolderContents | ( | [in] string | FolderURL, | |||
| [in] boolean | bIncludeFolders ) | |||||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Returns the contents of a folder.
| FolderURL | URL of the folder |
| bIncludeFolders | true: Subfolders are included, false: No subfolders |
| long getSize | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Returns the size of a file.
| FileURL | URL of the file |
| boolean isFolder | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Checks if a URL represents a folder.
| FileURL | URL to be checked |
| boolean isReadOnly | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Checks if a file is "read only".
| FileURL | URL to be checked |
| void kill | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Removes a file.
If the URL represents a folder, the folder will be removed, even if it's not empty.
| FileURL | File/folder to be removed |
| void move | ( | [in] string | SourceURL, | |||
| [in] string | DestURL ) | |||||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Moves a file.
| SourceURL | URL of the file to be moved |
| DestURL | URL of the location the file should be moved to |
| com::sun::star::io::XInputStream openFileRead | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Opens file to read.
| FileURL | File to open |
| com::sun::star::io::XStream openFileReadWrite | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Opens file to read and write.
| FileURL | File to open |
| 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. |
| com::sun::star::io::XOutputStream openFileWrite | ( | [in] string | FileURL | ) | ||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Opens file to write.
| FileURL | File to open |
| 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. |
| void setInteractionHandler | ( | [in] com::sun::star::task::XInteractionHandler | Handler | ) |
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.
| Handler | The interaction handler to be set |
| void setReadOnly | ( | [in] string | FileURL, | |||
| [in] boolean | bReadOnly ) | |||||
| raises | ( | com::sun::star::ucb::CommandAbortedException, | ||||
| com::sun::star::uno::Exception ) | ||||||
Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so.
| FileURL | URL of the file |
| bReadOnly | true; "read only" flag will be set, false; "read only" flag will be reset |