|
Syntax
- void copy
(
- string SourceURL,
- string DestURL )
- raises ( com::sun::star::ucb::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
-
Syntax
- void move
(
- string SourceURL,
- string DestURL )
- raises ( com::sun::star::ucb::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
-
Syntax
- void kill
(
- string FileURL )
- raises ( com::sun::star::ucb::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
-
Syntax
- boolean isFolder
(
- string FileURL )
- raises ( com::sun::star::ucb::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
Syntax
- boolean isReadOnly
(
- string FileURL )
- raises ( com::sun::star::ucb::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
Syntax
- void setReadOnly
(
- string FileURL,
- boolean bReadOnly )
- raises ( com::sun::star::ucb::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
Syntax
- void createFolder
(
- string NewFolderURL )
- raises ( com::sun::star::ucb::CommandAbortedException , com::sun::star::uno::Exception );
Description
Creates a new Folder
Parameter NewFolderURL
-
URL describing the location of the new folder
Syntax
- long getSize
(
- string FileURL )
- raises ( com::sun::star::ucb::CommandAbortedException , com::sun::star::uno::Exception );
Description
Returns the size of a file.
Parameter FileURL
-
URL of the file
Returns
- Size of the file
Syntax
- string getContentType
(
- string FileURL )
- raises ( com::sun::star::ucb::CommandAbortedException , com::sun::star::uno::Exception );
Description
Returns the content type of a file.
See also
- XContent::getContentType
-
Parameter FileURL
-
URL of the file
Returns
- Content type of the file
Syntax
- com::sun::star::util::DateTime getDateTimeModified
(
- string FileURL )
- raises ( com::sun::star::ucb::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
Syntax
- sequence< string > getFolderContents
(
- string FolderURL,
- boolean bIncludeFolders )
- raises ( com::sun::star::ucb::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
Syntax
- boolean exists
(
- string FileURL )
- raises ( com::sun::star::ucb::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
Syntax
- com::sun::star::io::XInputStream openFileRead
(
- string FileURL )
- raises ( com::sun::star::ucb::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
Syntax
- com::sun::star::io::XOutputStream openFileWrite
(
- string FileURL )
- raises ( com::sun::star::ucb::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.
Syntax
- com::sun::star::io::XStream openFileReadWrite
(
- string FileURL )
- raises ( com::sun::star::ucb::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.
Syntax
- void setInteractionHandler
(
- com::sun::star::task::XInteractionHandler Handler );
Description
|