Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


Methods of Class OStoreFile


OStoreFile
OStoreFile(
void ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Construction.

~OStoreFile
~OStoreFile(
void ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Destruction.

OStoreFile
OStoreFile(
const OStoreFile & rhs ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Copy construction.

operator=
OStoreFile & operator=(
const OStoreFile & rhs ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Assignment.

OStoreFile
explicit OStoreFile(
storeFileHandle Handle ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Construction from File Handle.

operator storeFileHandle
operator storeFileHandle(
void ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Conversion into File Handle.

isValid
bool isValid(
void ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Check for a valid File Handle.
Return
sal_True if valid, sal_False otherwise.

create
storeError create(
const rtl::OUString & rFilename,
storeAccessMode eAccessMode,
sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Open the file.
See Also
store_openFile()

createInMemory
storeError createInMemory(
sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Open the temporary file in memory.
See Also
store_createMemoryFile()

close
void close(
void ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Close the file.
See Also
store_closeFile()

flush
storeError flush(
void ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Flush the file.
See Also
store_flushFile()

getRefererCount
storeError getRefererCount(
sal_uInt32 & rnRefCount ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Get the number of referers to the file.
See Also
store_getFileRefererCount()

getSize
storeError getSize(
sal_uInt32 & rnSize ) const throw();

virtual abstract const volatile template static inline C-linkage
NO NO YES NO NO NO YES NO

Summary
Get the file size.
See Also
store_getFileSize()

attrib
storeError attrib(
const rtl::OUString & rPath,
const rtl::OUString & rName,
sal_uInt32 nMask1,
sal_uInt32 nMask2,
sal_uInt32 & rnAttrib ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Set attributes of a file entry.
See Also
store_attrib()

attrib
storeError attrib(
const rtl::OUString & rPath,
const rtl::OUString & rName,
sal_uInt32 nMask1,
sal_uInt32 nMask2 ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Set attributes of a file entry.
See Also
store_attrib()

link
storeError link(
const rtl::OUString & rSrcPath,
const rtl::OUString & rSrcName,
const rtl::OUString & rDstPath,
const rtl::OUString & rDstName ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Insert a file entry as 'hard link' to another file entry.
See Also
store_link()

symlink
storeError symlink(
const rtl::OUString & rSrcPath,
const rtl::OUString & rSrcName,
const rtl::OUString & rDstPath,
const rtl::OUString & rDstName ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Insert a file entry as 'symbolic link' to another file entry.
See Also
store_symlink()

rename
storeError rename(
const rtl::OUString & rSrcPath,
const rtl::OUString & rSrcName,
const rtl::OUString & rDstPath,
const rtl::OUString & rDstName ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Rename a file entry.
See Also
store_rename()

remove
storeError remove(
const rtl::OUString & rPath,
const rtl::OUString & rName ) throw();

virtual abstract const volatile template static inline C-linkage
NO NO NO NO NO NO YES NO

Summary
Remove a file entry.
See Also
store_remove()

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.