Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XFileIdentifierConverter
Description
specifies methods to convert between (file) URLs and file paths in system dependent notation.

Methods' Summary
getFileProviderLocality Get information about the 'locality' of a file content provider.  
getFileURLFromSystemPath converts a file path in system dependent notation to a (file) URL.  
getSystemPathFromFileURL converts a (file) URL to a file path in system dependent notation.  
Methods' Details
getFileProviderLocality
long
getFileProviderLocality( [in] string  BaseURL );

Description
Get information about the 'locality' of a file content provider.

The returned information can be used to chose the 'best' among a number of file content providers implementing this interface.

Parameter BaseURL
the base (file) URL used to specify a file content provider.
Returns
an appropriat value representing the 'locality' of the specified file content provider. Generally, higher (non-negative) numbers denote file content providers that are more 'local', and negative numbers denote content providers that are not file content providers at all. As a convention (and to keep this useful), values should be restricted to the range from -1 to +10, inclusive.
getFileURLFromSystemPath
string
getFileURLFromSystemPath( [in] string  BaseURL,
[in] string  SystemPath );

Description
converts a file path in system dependent notation to a (file) URL.
Parameter BaseURL
the base (file) URL relative to which the file path shall be interpreted.
Parameter SystemPath
a file path in system dependent notation.
Returns
the URL corresponding to the file path, or an empty string if the file path cannot be converted into a URL.
getSystemPathFromFileURL
string
getSystemPathFromFileURL( [in] string  URL );

Description
converts a (file) URL to a file path in system dependent notation.
Parameter URL
a (file) URL.
Returns
the file path corresponding to the URL, or an empty string if the URL cannot be converted into a file path.
Top of Page

Apache Software Foundation

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.