<html> <head> <title>Interface XSimpleFileAccess</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XSimpleFileAccess-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">ucb</a> :: </p> </td> </tr> <tr> <td class="title">interface XSimpleFileAccess</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This is the basic interface to read data from a stream. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#copy">copy</a></td> <td class="imsum_right">Copies a file </td> </tr> <tr> <td class="imsum_left"><a href="#move">move</a></td> <td class="imsum_right">Moves a file </td> </tr> <tr> <td class="imsum_left"><a href="#kill">kill</a></td> <td class="imsum_right">Removes a file. If the URL represents a folder, the folder will be removed, even if it's not empty. </td> </tr> <tr> <td class="imsum_left"><a href="#isFolder">isFolder</a></td> <td class="imsum_right">Checks if an URL represents a folder </td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td> <td class="imsum_right">Checks if a file is "read only" </td> </tr> <tr> <td class="imsum_left"><a href="#setReadOnly">setReadOnly</a></td> <td class="imsum_right">Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so. </td> </tr> <tr> <td class="imsum_left"><a href="#createFolder">createFolder</a></td> <td class="imsum_right">Creates a new Folder </td> </tr> <tr> <td class="imsum_left"><a href="#getSize">getSize</a></td> <td class="imsum_right">Returns the size of a file. </td> </tr> <tr> <td class="imsum_left"><a href="#getContentType">getContentType</a></td> <td class="imsum_right">Returns the content type of a file. </td> </tr> <tr> <td class="imsum_left"><a href="#getDateTimeModified">getDateTimeModified</a></td> <td class="imsum_right">Returns the last modified date for the file </td> </tr> <tr> <td class="imsum_left"><a href="#getFolderContents">getFolderContents</a></td> <td class="imsum_right">Returns the contents of a folder </td> </tr> <tr> <td class="imsum_left"><a href="#exists">exists</a></td> <td class="imsum_right">Checks if a file exists </td> </tr> <tr> <td class="imsum_left"><a href="#openFileRead">openFileRead</a></td> <td class="imsum_right">Opens file to read </td> </tr> <tr> <td class="imsum_left"><a href="#openFileWrite">openFileWrite</a></td> <td class="imsum_right">Opens file to write. </td> </tr> <tr> <td class="imsum_left"><a href="#openFileReadWrite">openFileReadWrite</a></td> <td class="imsum_right">Opens file to read and write </td> </tr> <tr> <td class="imsum_left"><a href="#setInteractionHandler">setInteractionHandler</a></td> <td class="imsum_right">Sets an interaction handler to be used for further operations. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="copy" class="membertitle">copy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>copy</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> SourceURL,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> DestURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Copies a file </dd> <dt><b>Parameter SourceURL</b></dt> <dd>URL of the file to be copied </dd> <dt><b>Parameter DestURL</b></dt> <dd>URL of the location the file should be copied to </dd> <dt><b>See also</b></dt> <dd><a href="#move">move</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="move" class="membertitle">move</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>move</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> SourceURL,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> DestURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Moves a file </dd> <dt><b>Parameter SourceURL</b></dt> <dd>URL of the file to be moved </dd> <dt><b>Parameter DestURL</b></dt> <dd>URL of the location the file should be moved to </dd> <dt><b>See also</b></dt> <dd><a href="#move">move</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="kill" class="membertitle">kill</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>kill</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes a file. If the URL represents a folder, the folder will be removed, even if it's not empty. </dd> <dt><b>Parameter FileURL</b></dt> <dd>File/folder to be removed </dd> <dt><b>See also</b></dt> <dd><a href="#move">move</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isFolder" class="membertitle">isFolder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isFolder</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if an URL represents a folder </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL to be checked </dd> <dt><b>Returns</b></dt> <dd>true, if the given URL represents a folder, otherwise false </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isReadOnly</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if a file is "read only" </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL to be checked </dd> <dt><b>Returns</b></dt> <dd>true, if the given File is "read only", false otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setReadOnly" class="membertitle">setReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setReadOnly</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReadOnly )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets the "read only" of a file according to the boolean parameter, if the actual process has the right to do so. </dd> <dt><b>Parameter bReadOnly</b></dt> <dd>true; "read only" flag will be set, false; "read only" flag will be reset </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createFolder" class="membertitle">createFolder</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>createFolder</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> NewFolderURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Creates a new Folder </dd> <dt><b>Parameter NewFolderURL</b></dt> <dd>URL describing the location of the new folder </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSize" class="membertitle">getSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getSize</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the size of a file. </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL of the file </dd> <dt><b>Returns</b></dt> <dd>Size of the file in bytes </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getContentType" class="membertitle">getContentType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getContentType</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the content type of a file. </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL of the file </dd> <dt><b>Returns</b></dt> <dd>Content type of the file </dd> <dt><b>See also</b></dt> <dd><a href="XContent.html">XContent</a>::<a href="XContent.html#getContentType">getContentType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDateTimeModified" class="membertitle">getDateTimeModified</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a></td> </tr> <tr> <td valign="top"><b>getDateTimeModified</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the last modified date for the file </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL of the file </dd> <dt><b>Returns</b></dt> <dd>Last modified date for the file </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getFolderContents" class="membertitle">getFolderContents</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getFolderContents</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FolderURL,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bIncludeFolders )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the contents of a folder </dd> <dt><b>Parameter FolderURL</b></dt> <dd>URL of the folder </dd> <dt><b>Parameter bIncludeFolders</b></dt> <dd>true: Subfolders are included, false: No subfolders </dd> <dt><b>Returns</b></dt> <dd>The content of a folder, each file as one string in a string sequence </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="exists" class="membertitle">exists</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>exists</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Checks if a file exists </dd> <dt><b>Parameter FileURL</b></dt> <dd>URL to be checked </dd> <dt><b>Returns</b></dt> <dd>true, if the File exists, false otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openFileRead" class="membertitle">openFileRead</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a></td> </tr> <tr> <td valign="top"><b>openFileRead</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Opens file to read </dd> <dt><b>Parameter FileURL</b></dt> <dd>File to open </dd> <dt><b>Returns</b></dt> <dd>An XInputStream, if the file can be opened for reading </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openFileWrite" class="membertitle">openFileWrite</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a></td> </tr> <tr> <td valign="top"><b>openFileWrite</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Opens file to write. </dd> <dt><b>Parameter FileURL</b></dt> <dd>File to open </dd> <dt><b>Returns</b></dt> <dd>An XOutputStream, if the file can be opened for writing </dd> <dt><b>Throws</b></dt> <dd><a href="UnsupportedDataSinkException.html">UnsupportedDataSinkException</a>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <a href="XSimpleFileAccess2.html">XSimpleFileAccess2</a>::<a href="XSimpleFileAccess2.html#writeFile">writeFile</a> may be used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="openFileReadWrite" class="membertitle">openFileReadWrite</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XStream.html">XStream</a></td> </tr> <tr> <td valign="top"><b>openFileReadWrite</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> FileURL )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Opens file to read and write </dd> <dt><b>Parameter FileURL</b></dt> <dd>File to open </dd> <dt><b>Returns</b></dt> <dd>An XStream, if the file can be opened for reading and writing </dd> <dt><b>Throws</b></dt> <dd><a href="UnsupportedDataSinkException.html">UnsupportedDataSinkException</a>, if the file cannot be opened for random write access. Some resources do not allow random write access. To write data for those resources <a href="XSimpleFileAccess2.html">XSimpleFileAccess2</a>::<a href="XSimpleFileAccess2.html#writeFile">writeFile</a> may be used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setInteractionHandler" class="membertitle">setInteractionHandler</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setInteractionHandler</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionHandler.html">XInteractionHandler</a></td> <td valign="bottom"> Handler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets an interaction handler to be used for further operations. </dd> <dd><p> A default interaction handler is available as service ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/InteractionHandler.html">InteractionHandler</a>. The documentation of this service also contains further information about the interaction handler concept. </p> </dd> <dt><b>Parameter Handler</b></dt> <dd>The interaction handler to be set </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/InteractionHandler.html">InteractionHandler</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>