summaryrefslogtreecommitdiff
path: root/include/osl/file.h
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2017-03-17 21:59:50 +1100
committerChris Sherlock <chris.sherlock79@gmail.com>2017-03-17 14:38:39 +0000
commit22750c14f2850281ca5235cc3c0a6d7c8a234fe0 (patch)
tree3625f888883dd4ec643f75ee89524f2f71140344 /include/osl/file.h
parent6bfb7aa4ef09eee32bd47c2f860546329de4ad98 (diff)
osl: use doxygen @retval and remove HTML markup
Change-Id: Ia0d0d6b0805612a26fcb3e1cf2f7d2555f7f98f1 Reviewed-on: https://gerrit.libreoffice.org/35331 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Chris Sherlock <chris.sherlock79@gmail.com>
Diffstat (limited to 'include/osl/file.h')
-rw-r--r--include/osl/file.h720
1 files changed, 329 insertions, 391 deletions
diff --git a/include/osl/file.h b/include/osl/file.h
index 12a0de8c9074..e99ff3bc7d19 100644
--- a/include/osl/file.h
+++ b/include/osl/file.h
@@ -35,26 +35,26 @@ extern "C" {
Main goals and usage hints
The main intentention of this interface is to provide an universal portable and
-high performance access to file system issues on any operating system.<p>
+high performance access to file system issues on any operating system.
-There are a few main goals:<p>
+There are a few main goals:
1.The path specifications always has to be absolute. Any usage of relative path
-specifications is forbidden. Exceptions are <code>osl_getSystemPathFromFileURL</code>,
-<code>osl_getFileURLFromSystemPath</code> and <code>osl_getAbsoluteFileURL</code>. Most operating systems
+specifications is forbidden. Exceptions are osl_getSystemPathFromFileURL,
+osl_getFileURLFromSystemPath and osl_getAbsoluteFileURL. Most operating systems
provide a "Current Directory" per process. This is the reason why relative path
-specifications can cause problems in multithreading environments.<p>
+specifications can cause problems in multithreading environments.
2.Proprietary notations of file paths are not supported. Every path notation
must the file URL specification. File URLs must be encoded in UTF8 and
after that escaped. Although the URL parameter is a unicode string, the must
-contain only ASCII characters<p>
+contain only ASCII characters
3.The caller cannot get any information whether a file system is case sensitive,
case preserving or not. The operating system implementation itself should
determine if it can map case-insensitive paths. The case correct notation of
a filename or file path is part of the "File Info". This case correct name
-can be used as a unique key if necessary.<p>
+can be used as a unique key if necessary.
4. Obtaining information about files or volumes is controlled by a
bitmask which specifies which fields are of interest. Due to performance
@@ -63,18 +63,18 @@ But if the operating system provides more information anyway the
implementation can set more fields on output as were requested. It is in the
responsibility of the caller to decide if he uses this additional information
or not. But he should do so to prevent further unnecessary calls if the information
-is already there.<br>
+is already there.
-The input bitmask supports a flag <code>osl_FileStatus_Mask_Validate</code> which
+The input bitmask supports a flag osl_FileStatus_Mask_Validate which
can be used to force retrieving uncached validated information. Setting this flag
-when calling <code>osl_getFileStatus</code> in combination with no other flag is
+when calling osl_getFileStatus in combination with no other flag is
a synonym for a "FileExists". This should only be done when processing a single file
(f.e. before opening) and NEVER during enumeration of directory contents on any step
of information processing. This would change the runtime behaviour from O(n) to
-O(n*n/2) on nearly every file system.<br>
+O(n*n/2) on nearly every file system.
On Windows NT reading the contents of an directory with 7000 entries and
getting full information about every file only takes 0.6 seconds. Specifying the
-flag <code>osl_FileStatus_Mask_Validate</code> for each entry will increase the
+flag osl_FileStatus_Mask_Validate for each entry will increase the
time to 180 seconds (!!!).
*/
@@ -148,17 +148,16 @@ typedef void *oslDirectoryItem;
On success it receives a handle used for subsequent calls by osl_getNextDirectoryItem().
The handle has to be released by a call to osl_closeDirectory().
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOENT the specified path doesn't exist<br>
- osl_File_E_NOTDIR the specified path is not an directory <br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_MFILE too many open files used by the process<br>
- osl_File_E_NFILE too many open files in the system<br>
- osl_File_E_NAMETOOLONG File name too long<br>
- osl_File_E_LOOP Too many symbolic links encountered<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOENT the specified path doesn't exist
+ @retval osl_File_E_NOTDIR the specified path is not an directory
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_MFILE too many open files used by the process
+ @retval osl_File_E_NFILE too many open files in the system
+ @retval osl_File_E_NAMETOOLONG File name too long
+ @retval osl_File_E_LOOP Too many symbolic links encountered
@see osl_getNextDirectoryItem()
@see osl_closeDirectory()
@@ -185,13 +184,12 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_openDirectory(
is going to call this function uHint times afterwards. This enables the implementation to
get the information for more than one file and cache it until the next calls.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_NOENT no more entries in this directory<br>
- osl_File_E_BADF invalid oslDirectory parameter<br>
- osl_File_E_OVERFLOW the value too large for defined data type
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_NOENT no more entries in this directory
+ @retval osl_File_E_BADF invalid oslDirectory parameter
+ @retval osl_File_E_OVERFLOW the value too large for defined data type
@see osl_releaseDirectoryItem()
@see osl_acquireDirectoryItem()
@@ -211,12 +209,11 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getNextDirectoryItem(
@param Directory [in]
A handle received by a call to osl_openDirectory().
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures<br>
- osl_File_E_BADF invalid oslDirectory parameter<br>
- osl_File_E_INTR the function call was interrupted<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_BADF invalid oslDirectory parameter
+ @retval osl_File_E_INTR the function call was interrupted
@see osl_openDirectory()
*/
@@ -238,22 +235,21 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeDirectory(
On success it receives a handle which can be used for subsequent calls to osl_getFileStatus().
The handle has to be released by a call to osl_releaseDirectoryItem().
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_MFILE too many open files used by the process<br>
- osl_File_E_NFILE too many open files in the system<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_NAMETOOLONG the file name is too long<br>
- osl_File_E_NOTDIR a component of the path prefix of path is not a directory<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_INTR the function call was interrupted<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_MFILE too many open files used by the process
+ @retval osl_File_E_NFILE too many open files in the system
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_NAMETOOLONG the file name is too long
+ @retval osl_File_E_NOTDIR a component of the path prefix of path is not a directory
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_INTR the function call was interrupted
@see osl_releaseDirectoryItem()
@see osl_acquireDirectoryItem()
@@ -274,10 +270,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getDirectoryItem(
@param Item [in]
A handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getDirectoryItem()
@see osl_getNextDirectoryItem()
@@ -297,10 +292,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireDirectoryItem(
@param Item [in]
A handle received by a call to osl_getDirectoryItem() or osl_getNextDirectoryItem().
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getDirectoryItem()
@see osl_getNextDirectoryItem()
@@ -321,9 +315,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseDirectoryItem(
@param pItemB [in]
A directory handle to compare with pItemA
- @return
- sal_True: if the items point to an identical resource<br>
- sal_False: if the items point to a different resource, or a fatal error occurred<br>
+ @retval sal_True if the items point to an identical resource
+ @retval sal_False if the items point to a different resource, or a fatal error occurred
@see osl_getDirectoryItem()
@@ -403,14 +396,14 @@ struct _oslFileStatus {
TimeValue aModifyTime;
/** Size in bytes of the file. Zero for directories and volumes. */
sal_uInt64 uFileSize;
-/** Case correct name of the file. Should be set to zero before calling <code>osl_getFileStatus</code>
+/** Case correct name of the file. Should be set to zero before calling osl_getFileStatus
and released after usage. */
rtl_uString *ustrFileName;
-/** Full URL of the file. Should be set to zero before calling <code>osl_getFileStatus</code>
+/** Full URL of the file. Should be set to zero before calling osl_getFileStatus
and released after usage. */
rtl_uString *ustrFileURL;
/** Full URL of the target file if the file itself is a link.
- Should be set to zero before calling <code>osl_getFileStatus</code>
+ Should be set to zero before calling osl_getFileStatus
and released after usage. */
rtl_uString *ustrLinkTargetURL;
} oslFileStatus;
@@ -429,26 +422,25 @@ struct _oslFileStatus {
@param uFieldMask [in]
Specifies which fields of the structure pointed to by pStatus are of interest to the caller.
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_BADF invalid oslDirectoryItem parameter<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_OVERFLOW value too large for defined data type<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_MULTIHOP components of path require hopping to multiple remote machines and the file system does not allow it<br>
- osl_File_E_MFILE too many open files used by the process<br>
- osl_File_E_NFILE too many open files in the system<br>
- osl_File_E_NOSPC no space left on device<br>
- osl_File_E_NXIO no such device or address<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_NOSYS function not implemented<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_BADF invalid oslDirectoryItem parameter
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_OVERFLOW value too large for defined data type
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_MULTIHOP components of path require hopping to multiple remote machines and the file system does not allow it
+ @retval osl_File_E_MFILE too many open files used by the process
+ @retval osl_File_E_NFILE too many open files in the system
+ @retval osl_File_E_NOSPC no space left on device
+ @retval osl_File_E_NXIO no such device or address
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_NOSYS function not implemented
@see osl_getDirectoryItem()
@see osl_getNextDirectoryItem()
@@ -469,8 +461,8 @@ typedef void *oslVolumeDeviceHandle;
@param Handle [in]
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
- @return
- osl_File_E_None on success<br>
+ @retval
+ osl_File_E_None on success
@todo
specify all error codes that may be returned
@@ -491,8 +483,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_releaseVolumeDeviceHandle(
@param Handle [in]
An oslVolumeDeviceHandle received by a call to osl_getVolumeInformation().
- @return
- osl_File_E_None on success<br>
+ @retval
+ osl_File_E_None on success
@todo
specify all error codes that may be returned
@@ -512,20 +504,19 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_acquireVolumeDeviceHandle(
@param ppustrDirectoryURL [out]
Receives the full qualified URL where the device is mounted to.
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_NXIO no such device or address<br>
- osl_File_E_NODEV no such device<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_FAULT bad address<br>
- osl_FilE_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_EOVERFLOW value too large for defined data type<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_NXIO no such device or address
+ @retval osl_File_E_NODEV no such device
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_FAULT bad address
+ @retval osl_FilE_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_EOVERFLOW value too large for defined data type
@see osl_getVolumeInformation()
*/
@@ -582,10 +573,10 @@ struct _oslVolumeInfo {
sal_uInt32 uMaxNameLength;
/** Maximum length of a full quallified path in system notation */
sal_uInt32 uMaxPathLength;
-/** Points to a string that receives the name of the file system type. String should be set to zero before calling <code>osl_getVolumeInformation</code>
+/** Points to a string that receives the name of the file system type. String should be set to zero before calling osl_getVolumeInformation
and released after usage. */
rtl_uString *ustrFileSystemName;
-/** Pointer to handle the receives underlying device. Handle should be set to zero before calling <code>osl_getVolumeInformation</code>*/
+/** Pointer to handle the receives underlying device. Handle should be set to zero before calling osl_getVolumeInformation*/
oslVolumeDeviceHandle *pDeviceHandle;
} oslVolumeInfo;
@@ -606,21 +597,20 @@ struct _oslVolumeInfo {
@param uFieldMask [in]
Specifies which members of the structure should be filled
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- ols_File_E_FAULT Bad address<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_NOSYS function not implemented<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_INTR function call was interrupted<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval ols_File_E_FAULT Bad address
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_NOSYS function not implemented
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_INTR function call was interrupted
@see osl_getFileStatus()
@see oslVolumeInfo
@@ -660,32 +650,31 @@ typedef void *oslFileHandle;
the LibreOffice Android bootstrapping code. So files "opened" from
there aren't actually files in the OS sense.
- @return
- osl_File_E_None on success<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NAMETOOLONG pathname was too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_AGAIN a write lock could not be established<br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_NXIO no such device or address<br>
- osl_File_E_NODEV no such device<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_TXTBSY text file busy<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_NOSPC no space left on device<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_MFILE too many open files used by the process<br>
- osl_File_E_NFILE too many open files in the system<br>
- osl_File_E_DQUOT quota exceeded<br>
- osl_File_E_EXIST file exists<br>
- osl_FilE_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_EOVERFLOW value too large for defined data type<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NAMETOOLONG pathname was too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_AGAIN a write lock could not be established
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_NXIO no such device or address
+ @retval osl_File_E_NODEV no such device
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_TXTBSY text file busy
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_NOSPC no space left on device
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_MFILE too many open files used by the process
+ @retval osl_File_E_NFILE too many open files in the system
+ @retval osl_File_E_DQUOT quota exceeded
+ @retval osl_File_E_EXIST file exists
+ @retval osl_FilE_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_EOVERFLOW value too large for defined data type
@see osl_closeFile()
@see osl_setFilePos()
@@ -714,10 +703,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_openFile(
@param uPos [in]
Absolute position from the beginning of the file.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
@see osl_openFile()
@see osl_getFilePos()
@@ -735,10 +723,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFilePos(
@param pPos [out]
On success receives the current position of the file pointer.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
@see osl_openFile()
@see osl_setFilePos()
@@ -761,10 +748,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFilePos(
@param uSize [in]
New size in bytes.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
@see osl_openFile()
@see osl_setFilePos()
@@ -787,10 +773,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileSize(
@param pSize [out]
Current size in bytes.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_OVERFLOW the resulting file offset would be a value which cannot be represented correctly for regular files
@see osl_openFile()
@see osl_setFilePos()
@@ -895,16 +880,15 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_unmapMappedFile (
@param pBytesRead [out]
On success the number of bytes which have actually been retrieved.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_BADF bad file<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_AGAIN operation would block<br>
- osl_File_E_NOLINK link has been severed<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_BADF bad file
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_AGAIN operation would block
+ @retval osl_File_E_NOLINK link has been severed
@see osl_openFile()
@see osl_writeFile()
@@ -924,16 +908,15 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_readFile(
@param pIsEOF [out]
Points to a variable that receives the end-of-file status.
- @return
- osl_File_E_None on success <br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_BADF bad file<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_AGAIN operation would block<br>
- osl_File_E_NOLINK link has been severed<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_BADF bad file
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_AGAIN operation would block
+ @retval osl_File_E_NOLINK link has been severed
@see osl_openFile()
@see osl_readFile()
@@ -962,20 +945,19 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_isEndOfFile(
@param pBytesWritten [out]
On success the number of bytes which have actually been written.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_FBIG file too large<br>
- osl_File_E_DQUOT quota exceeded<p>
- osl_File_E_AGAIN operation would block<br>
- osl_File_E_BADF bad file<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errosr<br>
- osl_File_E_NOLCK no record locks available<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_NOSPC no space left on device<br>
- osl_File_E_NXIO no such device or address<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_FBIG file too large
+ @retval osl_File_E_DQUOT quota exceeded
+ @retval osl_File_E_AGAIN operation would block
+ @retval osl_File_E_BADF bad file
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errosr
+ @retval osl_File_E_NOLCK no record locks available
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_NOSPC no space left on device
+ @retval osl_File_E_NXIO no such device or address
@see osl_openFile()
@see osl_readFile()
@@ -1025,16 +1007,15 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_writeFileAt(
@param ppSequence [in/out]
A pointer pointer to a sal_Sequence that will hold the line read on success.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_BADF bad file<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_AGAIN operation would block<br>
- osl_File_E_NOLINK link has been severed<p>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_BADF bad file
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_AGAIN operation would block
+ @retval osl_File_E_NOLINK link has been severed
@see osl_openFile()
@see osl_readFile()
@@ -1055,26 +1036,13 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_readLine(
@param Handle
[in] Handle to a file received by a previous call to osl_openFile().
- @return
- <dl>
- <dt>osl_File_E_None</dt>
- <dd>On success</dd>
- <dt>osl_File_E_INVAL</dt>
- <dd>The value of the input parameter is invalid</dd>
- </dl>
- <br><p><strong>In addition to these error codes others may occur as well, for instance:</strong></p><br>
- <dl>
- <dt>osl_File_E_BADF</dt>
- <dd>The file associated with the given file handle is not open for writing</dd>
- <dt>osl_File_E_IO</dt>
- <dd>An I/O error occurred</dd>
- <dt>osl_File_E_NOSPC</dt>
- <dd>There is no enough space on the target device</dd>
- <dt>osl_File_E_ROFS</dt>
- <dd>The file associated with the given file handle is located on a read only file system</dd>
- <dt>osl_File_E_TIMEDOUT</dt>
- <dd>A remote connection timed out. This may happen when a file is on a remote location</dd>
- </dl>
+ @retval osl_File_E_None On success
+ @retval osl_File_E_INVAL The value of the input parameter is invalid
+ @retval osl_File_E_BADF The file associated with the given file handle is not open for writing
+ @retval osl_File_E_IO An I/O error occurred
+ @retval osl_File_E_NOSPC There is no enough space on the target device
+ @retval osl_File_E_ROFS The file associated with the given file handle is located on a read only file system
+ @retval osl_File_E_TIMEDOUT A remote connection timed out. This may happen when a file is on a remote location
@see osl_openFile()
@see osl_writeFile()
@@ -1087,13 +1055,13 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_syncFile( oslFileHandle Handle );
Handle to a file received by a previous call to osl_openFile().
@return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_BADF Bad file<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_NOSPC no space left on device<br>
- osl_File_E_IO on I/O errors<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_BADF Bad file
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_NOSPC no space left on device
+ @retval osl_File_E_IO on I/O errors
@see osl_openFile()
*/
@@ -1107,23 +1075,23 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_closeFile( oslFileHandle Handle );
Full qualified URL of the directory to create.
@return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_EXIST file exists<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_NOSPC no space left on device<br>
- osl_File_E_DQUOT quota exceeded<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_FAULT bad address<br>
- osl_FileE_IO on I/O errors<br>
- osl_File_E_MLINK too many links<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_EXIST file exists
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_NOSPC no space left on device
+ @retval osl_File_E_DQUOT quota exceeded
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_FAULT bad address
+ @retval osl_FileE_IO on I/O errors
+ @retval osl_File_E_MLINK too many links
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
@see osl_removeDirectory()
*/
@@ -1153,23 +1121,23 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryWithFlags(
Full qualified URL of the directory.
@return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_PERM operation not permitted<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_NOTEMPTY directory not empty<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_BUSY device or resource busy<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_EXIST file exists<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_PERM operation not permitted
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_NOTEMPTY directory not empty
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_BUSY device or resource busy
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_EXIST file exists
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
@see osl_createDirectory()
*/
@@ -1197,9 +1165,9 @@ typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uStri
The osl_createDirectoryPath function creates a specified directory path.
All nonexisting sub directories will be created.
- <p><strong>PLEASE NOTE:</strong> You cannot rely on getting the error code
+ <strong>PLEASE NOTE:</strong> You cannot rely on getting the error code
osl_File_E_EXIST for existing directories. Programming against this error
- code is in general a strong indication of a wrong usage of osl_createDirectoryPath.</p>
+ code is in general a strong indication of a wrong usage of osl_createDirectoryPath.
@param aDirectoryUrl
[in] The absolute file URL of the directory path to create.
@@ -1216,37 +1184,20 @@ typedef void (SAL_CALL *oslDirectoryCreationCallbackFunc)(void* pData, rtl_uStri
callback function. The value of this parameter may be arbitrary
and will not be interpreted by osl_createDirectoryPath.
- @return
- <dl>
- <dt>osl_File_E_None</dt>
- <dd>On success</dd>
- <dt>osl_File_E_INVAL</dt>
- <dd>The format of the parameters was not valid</dd>
- <dt>osl_File_E_ACCES</dt>
- <dd>Permission denied</dd>
- <dt>osl_File_E_EXIST</dt>
- <dd>The final node of the specified directory path already exist</dd>
- <dt>osl_File_E_NAMETOOLONG</dt>
- <dd>The name of the specified directory path exceeds the maximum allowed length</dd>
- <dt>osl_File_E_NOTDIR</dt>
- <dd>A component of the specified directory path already exist as file in any part of the directory path</dd>
- <dt>osl_File_E_ROFS</dt>
- <dd>Read-only file system</dd>
- <dt>osl_File_E_NOSPC</dt>
- <dd>No space left on device</dd>
- <dt>osl_File_E_DQUOT</dt>
- <dd>Quota exceeded</dd>
- <dt>osl_File_E_FAULT</dt>
- <dd>Bad address</dd>
- <dt>osl_File_E_IO</dt>
- <dd>I/O error</dd>
- <dt>osl_File_E_LOOP</dt>
- <dd>Too many symbolic links encountered</dd>
- <dt>osl_File_E_NOLINK</dt>
- <dd>Link has been severed</dd>
- <dt>osl_File_E_invalidError</dt>
- <dd>An unknown error occurred</dd>
- </dl>
+ @retval osl_File_E_None On success
+ @retval osl_File_E_INVAL The format of the parameters was not valid
+ @retval osl_File_E_ACCES Permission denied
+ @retval osl_File_E_EXIST The final node of the specified directory path already exist
+ @retval osl_File_E_NAMETOOLONG The name of the specified directory path exceeds the maximum allowed length
+ @retval osl_File_E_NOTDIR A component of the specified directory path already exist as file in any part of the directory path
+ @retval osl_File_E_ROFS Read-only file system
+ @retval osl_File_E_NOSPC No space left on device
+ @retval osl_File_E_DQUOT Quota exceeded
+ @retval osl_File_E_FAULT Bad address
+ @retval osl_File_E_IO I/O error
+ @retval osl_File_E_LOOP Too many symbolic links encountered
+ @retval osl_File_E_NOLINK Link has been severed
+ @retval osl_File_E_invalidError An unknown error occurred
@see oslDirectoryCreationFunc
@see oslFileError
@@ -1262,25 +1213,24 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_createDirectoryPath(
@param pustrFileURL [in]
Full qualified URL of the file to remove.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_PERM operation not permitted<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_IO on I/O errors<br>
- osl_File_E_BUSY device or resource busy<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
- osl_File_E_TXTBSY text file busy<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_PERM operation not permitted
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_IO on I/O errors
+ @retval osl_File_E_BUSY device or resource busy
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
+ @retval osl_File_E_TXTBSY text file busy
@see osl_openFile()
*/
@@ -1300,17 +1250,16 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_removeFile(
@param pustrDestFileURL [in]
Full qualified URL of the destination file. A directory is NOT a valid destination file!
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_PERM operation not permitted<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_ISDIR is a directory<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_BUSY if the implementation internally requires resources that are
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_PERM operation not permitted
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_ISDIR is a directory
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_BUSY if the implementation internally requires resources that are
(temporarily) unavailable (added with LibreOffice 4.4)
@see osl_moveFile()
@@ -1332,16 +1281,15 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_copyFile(
@param pustrDestFileURL [in]
Full qualified URL of the destination file. An existing directory is NOT a valid destination !
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_PERM operation not permitted<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_ROFS read-only file system<br>
- osl_File_E_BUSY if the implementation internally requires resources that are
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_PERM operation not permitted
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_ROFS read-only file system
+ @retval osl_File_E_BUSY if the implementation internally requires resources that are
(temporarily) unavailable (added with LibreOffice 4.4)
@see osl_copyFile()
@@ -1365,9 +1313,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_moveFile(
On success receives a name which is unused and valid on the actual Operating System and
File System.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getFileStatus()
*/
@@ -1393,20 +1340,19 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getCanonicalName(
@param ppustrAbsoluteFileURL [out]
On success it receives the full qualified absolute file URL.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOMEM not enough memory for allocating structures <br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_ACCES permission denied<br>
- osl_File_E_NOENT no such file or directory<br>
- osl_File_E_NAMETOOLONG file name too long<br>
- osl_File_E_OVERFLOW value too large for defined data type<br>
- osl_File_E_FAULT bad address<br>
- osl_File_E_INTR function call was interrupted<br>
- osl_File_E_LOOP too many symbolic links encountered<br>
- osl_File_E_MULTIHOP multihop attempted<br>
- osl_File_E_NOLINK link has been severed<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_ACCES permission denied
+ @retval osl_File_E_NOENT no such file or directory
+ @retval osl_File_E_NAMETOOLONG file name too long
+ @retval osl_File_E_OVERFLOW value too large for defined data type
+ @retval osl_File_E_FAULT bad address
+ @retval osl_File_E_INTR function call was interrupted
+ @retval osl_File_E_LOOP too many symbolic links encountered
+ @retval osl_File_E_MULTIHOP multihop attempted
+ @retval osl_File_E_NOLINK link has been severed
@see osl_getFileStatus()
*/
@@ -1425,9 +1371,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getAbsoluteFileURL(
@param ppustrFileURL [out]
On success it receives the file URL.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getSystemPathFromFileURL()
*/
@@ -1454,11 +1399,10 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getFileURLFromSystemPath(
@param ppustrFileURL [out]
On success it receives the full qualified file URL.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOTDIR not a directory<br>
- osl_File_E_NOENT no such file or directory not found<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOTDIR not a directory
+ @retval osl_File_E_NOENT no such file or directory not found
@see osl_getFileURLFromSystemPath()
@see osl_getSystemPathFromFileURL()
@@ -1476,9 +1420,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_searchFileURL(
@param ppustrSystemPath [out]
On success it receives the system path.
- @return
- osl_File_E_None on success
- osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getFileURLFromSystemPath()
*/
@@ -1517,8 +1460,7 @@ typedef sal_uInt32 (SAL_CALL *oslCalcTextWidthFunc)( rtl_uString *ustrText );
Maximum width allowed that is retunrned from pCalcWidth.
If pCalcWidth is zero the character count is assumed as width.
- @return
- osl_File_E_None on success<br>
+ @retval osl_File_E_None on success
@see oslCalcTextWidthFunc
*/
@@ -1538,9 +1480,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_abbreviateSystemPath(
@param uAttributes [in]
Attributes of the file to be set.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
@see osl_getFileStatus()
*/
@@ -1563,10 +1504,9 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileAttributes(
@param aLastWriteTime [in]
Time of the last modifying of the given file.
- @return
- osl_File_E_None on success<br>
- osl_File_E_INVAL the format of the parameters was not valid<br>
- osl_File_E_NOENT no such file or directory not found<br>
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameters was not valid
+ @retval osl_File_E_NOENT no such file or directory not found
@see osl_getFileStatus()
*/
@@ -1583,9 +1523,8 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_setFileTime(
@param[out] pustrTempDirURL
On success receives the URL of system's temporary directory path.
- @return
- osl_File_E_None on success
- osl_File_E_NOENT no such file or directory not found
+ @retval osl_File_E_None on success
+ @retval osl_File_E_NOENT no such file or directory not found
*/
SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
@@ -1629,16 +1568,15 @@ SAL_DLLPUBLIC oslFileError SAL_CALL osl_getTempDirURL(
file and is responsible for removing the file, in this case
*ppustrTempFileURL must be 0 or must point to a valid rtl_uString.
- @return
- osl_File_E_None on success
- osl_File_E_INVAL the format of the parameter is invalid
- osl_File_E_NOMEM not enough memory for allocating structures
- osl_File_E_ACCES Permission denied
- osl_File_E_NOENT No such file or directory
- osl_File_E_NOTDIR Not a directory
- osl_File_E_ROFS Read-only file system
- osl_File_E_NOSPC No space left on device
- osl_File_E_DQUOT Quota exceeded
+ @retval osl_File_E_None on success
+ @retval osl_File_E_INVAL the format of the parameter is invalid
+ @retval osl_File_E_NOMEM not enough memory for allocating structures
+ @retval osl_File_E_ACCES Permission denied
+ @retval osl_File_E_NOENT No such file or directory
+ @retval osl_File_E_NOTDIR Not a directory
+ @retval osl_File_E_ROFS Read-only file system
+ @retval osl_File_E_NOSPC No space left on device
+ @retval osl_File_E_DQUOT Quota exceeded
@see osl_getTempDirURL()
*/