Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15
 Overview   Namespace   Class   Index   Help 

Global Functions in Global Namespace C++
in Sourcefile store.h

store_acquireHandle
extern "C"
storeError store_acquireHandle(
storeHandle Handle );

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

Summary
Acquire a Handle.
Parameters
Handle 
the Handle.
Return
store_E_None upon success
store_attrib
extern "C"
storeError store_attrib(
storeFileHandle hFile,
rtl_uString * pPath,
rtl_uString * pName,
sal_uInt32 nMask1,
sal_uInt32 nMask2,
sal_uInt32 * pnAttrib );

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

Summary
Set attributes of a file entry.
Parameters
hFile 
the File Handle.
pPath 
the entry path.
pName 
the entry name.
nMask1 
the attributes to be cleared.
nMask2 
the attributes to be set.
pnAttrib 
the resulting attributes, may be NULL.
Return
store_E_None upon success
store_closeDirectory
extern "C"
storeError store_closeDirectory(
storeDirectoryHandle hDirectory );

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

Summary
Close a directory.
Parameters
hDirectory 
the Directory Handle.
Return
store_E_None upon success, store_E_InvalidHandle otherwise.
store_closeFile
extern "C"
storeError store_closeFile(
storeFileHandle hFile );

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

Summary
Close a file.
Parameters
hFile 
the File Handle.
Return
store_E_None upon success, store_E_InvalidHandle otherwise.
store_closeStream
extern "C"
storeError store_closeStream(
storeStreamHandle hStrm );

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

Summary
Close a stream.
Parameters
hStrm 
the Stream Handle.
Return
store_E_None upon success, store_E_InvalidHandle otherwise.
store_createMemoryFile
extern "C"
storeError store_createMemoryFile(
sal_uInt16 nPageSize,
storeFileHandle * phFile );

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

Summary
Open a temporary file in memory.
Parameters
nPageSize 
the creation page size,
        integer multiple of minimum page size.
phFile 
the File Handle.
Return
store_E_None upon success
store_findFirst
extern "C"
storeError store_findFirst(
storeDirectoryHandle hDirectory,
storeFindData * pFindData );

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

Summary
Find first directory entry.
Parameters
hDirectory 
the Directory Handle.
pFindData 
the Find Data structure.
Return
store_E_None upon success, store_E_NoMoreFile upon end of iteration.
store_findNext
extern "C"
storeError store_findNext(
storeDirectoryHandle hDirectory,
storeFindData * pFindData );

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

Summary
Find next directory entry.
Parameters
hDirectory 
the Directory Handle.
pFindData 
the Find Data structure.
Return
store_E_None upon success, store_E_NoMoreFile upon end of iteration.
store_flushFile
extern "C"
storeError store_flushFile(
storeFileHandle hFile );

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

Summary
Flush a file.
Parameters
hFile 
the File Handle.
Return
store_E_None upon success
store_flushStream
extern "C"
storeError store_flushStream(
storeStreamHandle hStrm );

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

Summary
Flush a stream.
Parameters
hStrm 
the Stream Handle.
Return
store_E_None upon success
store_getFileRefererCount
extern "C"
storeError store_getFileRefererCount(
storeFileHandle hFile,
sal_uInt32 * pnRefCount );

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

Summary
Get the number of referers to a file.
Parameters
hFile 
the File Handle.
pnRefCount 
number of open directories and streams.
Return
store_E_None upon success
store_getFileSize
extern "C"
storeError store_getFileSize(
storeFileHandle hFile,
sal_uInt32 * pnSize );

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

Summary
Get the size of a file.
Parameters
hFile 
the File Handle.
pnSize 
the file size in bytes.
Return
store_E_None upon success
store_getStreamSize
extern "C"
storeError store_getStreamSize(
storeStreamHandle hStrm,
sal_uInt32 * pnSize );

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

Summary
Get the size of a stream.
Parameters
hStrm 
the Stream Handle.
pnSize 
the stream size in bytes.
Return
store_E_None upon success
store_link
extern "C"
storeError store_link(
storeFileHandle hFile,
rtl_uString * pSrcPath,
rtl_uString * pSrcName,
rtl_uString * pDstPath,
rtl_uString * pDstName );

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

Summary
Insert a file entry as 'hard link' to another file entry.
Precondition
Source must not exist, Destination must exist.
Postcondition
Source has attribute STORE_ATTRIB_ISLINK.
See Also
store_attrib()
Parameters
hFile 
the File Handle
pSrcPath 
the Source path
pSrcName 
the Source name
pDstPath 
the Destination path
pDstName 
the Destination name
Return
store_E_None upon success
store_openDirectory
extern "C"
storeError store_openDirectory(
storeFileHandle hFile,
rtl_uString * pPath,
rtl_uString * pName,
storeAccessMode eAccessMode,
storeDirectoryHandle * phDirectory );

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

Summary
Open a directory.
See Also
store_openFile()
Parameters
hFile 
the File Handle.
pPath 
the directory path.
pName 
the directory name.
eAccessMode 
the access mode.
phDirectory 
the Directory Handle.
Return
store_E_None upon success
store_openFile
extern "C"
storeError store_openFile(
rtl_uString * pFilename,
storeAccessMode eAccessMode,
sal_uInt16 nPageSize,
storeFileHandle * phFile );

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

Summary
Open a file.
Parameters
pFilename 
the filename as URL or system path.
eAccessMode 
the access mode.
        store_AccessCreate     truncate existing and create,
        store_AccessReadCreate create not existing,
        store_AccessReadWrite  write existing,
        store_AccessReadOnly   never modifies.
nPageSize 
the creation page size,
        integer multiple of minimum page size.
phFile 
the File Handle.
Return
store_E_None upon success
store_openStream
extern "C"
storeError store_openStream(
storeFileHandle hFile,
rtl_uString * pPath,
rtl_uString * pName,
storeAccessMode eMode,
storeStreamHandle * phStrm );

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

Summary
Open a stream.
See Also
store_openFile()
Parameters
hFile 
the File Handle.
pPath 
the stream path.
pName 
the stream name.
eAccessMode 
the access mode.
phStrm 
the Stream Handle.
Return
store_E_None upon success
store_readStream
extern "C"
storeError store_readStream(
storeStreamHandle hStrm,
sal_uInt32 nOffset,
void * pBuffer,
sal_uInt32 nBytes,
sal_uInt32 * pnDone );

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

Summary
Read from a stream.
Parameters
hStrm 
the Stream Handle.
nOffset 
the offset of the first byte to read.
pBuffer 
the buffer.
nBytes 
the number of bytes to read.
pnDone 
the number of bytes actually read.
Return
store_E_None upon success
store_rebuildFile
extern "C"
storeError store_rebuildFile(
rtl_uString * pSrcFilename,
rtl_uString * pDstFilename );

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

Summary
Recover and Compact a file into another file.
See Also
store_openFile()
Parameters
pSrcFilename 
opened with store_AccessReadOnly.
pDstFilename 
created with store_AccessCreate.
Return
store_E_None upon success
store_releaseHandle
extern "C"
storeError store_releaseHandle(
storeHandle Handle );

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

Summary
Release a Handle.
Parameters
Handle 
the Handle.
Return
store_E_None upon success, store_E_InvalidHandle otherwise.
store_remove
extern "C"
storeError store_remove(
storeFileHandle hFile,
rtl_uString * pPath,
rtl_uString * pName );

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

Summary
Remove a file entry.
Parameters
hFile 
the File Handle
pPath 
the entry path
pName 
the entry name
Return
store_E_None upon success
store_rename
extern "C"
storeError store_rename(
storeFileHandle hFile,
rtl_uString * pSrcPath,
rtl_uString * pSrcName,
rtl_uString * pDstPath,
rtl_uString * pDstName );

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

Summary
Rename a file entry.
Parameters
hFile 
the File Handle
pSrcPath 
the Source path
pSrcName 
the Source name
pDstPath 
the Destination path
pDstName 
the Destination name
Return
store_E_None upon success
store_setStreamSize
extern "C"
storeError store_setStreamSize(
storeStreamHandle hStrm,
sal_uInt32 nSize );

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

Summary
Set the size of a stream.
Parameters
hStrm 
the Stream Handle.
nSize 
the new stream size in bytes.
Return
store_E_None upon success
store_symlink
extern "C"
storeError store_symlink(
storeFileHandle hFile,
rtl_uString * pSrcPath,
rtl_uString * pSrcName,
rtl_uString * pDstPath,
rtl_uString * pDstName );

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

Summary
Insert a file entry as 'symbolic link' to another file entry.
Precondition
Source must not exist
Postcondition
Source has attribute STORE_ATTRIB_ISLINK.
See Also
store_attrib()
Parameters
hFile 
the File Handle
pSrcPath 
the Source path
pSrcName 
the Source name
pDstPath 
the Destination path
pDstName 
the Destination name
Return
store_E_None upon success
store_writeStream
extern "C"
storeError store_writeStream(
storeStreamHandle hStrm,
sal_uInt32 nOffset,
const void * pBuffer,
sal_uInt32 nBytes,
sal_uInt32 * pnDone );

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

Summary
Write to a stream.
Parameters
hStrm 
the Stream Handle.
nOffset 
the offset of the first byte to write.
pBuffer 
the buffer.
nBytes 
the number of bytes to write.
pnDone 
the number of bytes actually written.
Return
store_E_None upon success
Top of Page

Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.

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.