UDK 3.2.7 C/C++ API Reference
Typedefs | Functions
store/store.h File Reference
#include <store/types.h>
#include <store/storedllapi.h>

Go to the source code of this file.

Typedefs

typedef void * storeHandle
 Handle opaque type.
typedef void * storeFileHandle
 File Handle opaque type.
typedef void * storeDirectoryHandle
 Directory Handle opaque type.
typedef void * storeStreamHandle
 Stream Handle opaque type.

Functions

STORE_DLLPUBLIC storeError store_acquireHandle (storeHandle Handle) SAL_THROW_EXTERN_C()
 Acquire a Handle.
STORE_DLLPUBLIC storeError store_releaseHandle (storeHandle Handle) SAL_THROW_EXTERN_C()
 Release a Handle.
STORE_DLLPUBLIC storeError store_createMemoryFile (sal_uInt16 nPageSize, storeFileHandle *phFile) SAL_THROW_EXTERN_C()
 Open a temporary file in memory.
STORE_DLLPUBLIC storeError store_openFile (rtl_uString *pFilename, storeAccessMode eAccessMode, sal_uInt16 nPageSize, storeFileHandle *phFile) SAL_THROW_EXTERN_C()
 Open a file.
STORE_DLLPUBLIC storeError store_closeFile (storeFileHandle hFile) SAL_THROW_EXTERN_C()
 Close a file.
STORE_DLLPUBLIC storeError store_flushFile (storeFileHandle hFile) SAL_THROW_EXTERN_C()
 Flush a file.
STORE_DLLPUBLIC storeError store_getFileRefererCount (storeFileHandle hFile, sal_uInt32 *pnRefCount) SAL_THROW_EXTERN_C()
 Get the number of referers to a file.
STORE_DLLPUBLIC storeError store_getFileSize (storeFileHandle hFile, sal_uInt32 *pnSize) SAL_THROW_EXTERN_C()
 Get the size of a file.
STORE_DLLPUBLIC storeError store_rebuildFile (rtl_uString *pSrcFilename, rtl_uString *pDstFilename) SAL_THROW_EXTERN_C()
 Recover and Compact a file into another file.
STORE_DLLPUBLIC storeError store_openDirectory (storeFileHandle hFile, rtl_uString *pPath, rtl_uString *pName, storeAccessMode eAccessMode, storeDirectoryHandle *phDirectory) SAL_THROW_EXTERN_C()
 Open a directory.
STORE_DLLPUBLIC storeError store_closeDirectory (storeDirectoryHandle hDirectory) SAL_THROW_EXTERN_C()
 Close a directory.
STORE_DLLPUBLIC storeError store_findFirst (storeDirectoryHandle hDirectory, storeFindData *pFindData) SAL_THROW_EXTERN_C()
 Find first directory entry.
STORE_DLLPUBLIC storeError store_findNext (storeDirectoryHandle hDirectory, storeFindData *pFindData) SAL_THROW_EXTERN_C()
 Find next directory entry.
STORE_DLLPUBLIC storeError store_openStream (storeFileHandle hFile, rtl_uString *pPath, rtl_uString *pName, storeAccessMode eMode, storeStreamHandle *phStrm) SAL_THROW_EXTERN_C()
 Open a stream.
STORE_DLLPUBLIC storeError store_closeStream (storeStreamHandle hStrm) SAL_THROW_EXTERN_C()
 Close a stream.
STORE_DLLPUBLIC storeError store_readStream (storeStreamHandle hStrm, sal_uInt32 nOffset, void *pBuffer, sal_uInt32 nBytes, sal_uInt32 *pnDone) SAL_THROW_EXTERN_C()
 Read from a stream.
STORE_DLLPUBLIC storeError store_writeStream (storeStreamHandle hStrm, sal_uInt32 nOffset, const void *pBuffer, sal_uInt32 nBytes, sal_uInt32 *pnDone) SAL_THROW_EXTERN_C()
 Write to a stream.
STORE_DLLPUBLIC storeError store_flushStream (storeStreamHandle hStrm) SAL_THROW_EXTERN_C()
 Flush a stream.
STORE_DLLPUBLIC storeError store_getStreamSize (storeStreamHandle hStrm, sal_uInt32 *pnSize) SAL_THROW_EXTERN_C()
 Get the size of a stream.
STORE_DLLPUBLIC storeError store_setStreamSize (storeStreamHandle hStrm, sal_uInt32 nSize) SAL_THROW_EXTERN_C()
 Set the size of a stream.
STORE_DLLPUBLIC storeError store_attrib (storeFileHandle hFile, rtl_uString *pPath, rtl_uString *pName, sal_uInt32 nMask1, sal_uInt32 nMask2, sal_uInt32 *pnAttrib) SAL_THROW_EXTERN_C()
 Set attributes of a file entry.
STORE_DLLPUBLIC storeError store_link (storeFileHandle hFile, rtl_uString *pSrcPath, rtl_uString *pSrcName, rtl_uString *pDstPath, rtl_uString *pDstName) SAL_THROW_EXTERN_C()
 Insert a file entry as 'hard link' to another file entry.
STORE_DLLPUBLIC storeError store_symlink (storeFileHandle hFile, rtl_uString *pSrcPath, rtl_uString *pSrcName, rtl_uString *pDstPath, rtl_uString *pDstName) SAL_THROW_EXTERN_C()
 Insert a file entry as 'symbolic link' to another file entry.
STORE_DLLPUBLIC storeError store_rename (storeFileHandle hFile, rtl_uString *pSrcPath, rtl_uString *pSrcName, rtl_uString *pDstPath, rtl_uString *pDstName) SAL_THROW_EXTERN_C()
 Rename a file entry.
STORE_DLLPUBLIC storeError store_remove (storeFileHandle hFile, rtl_uString *pPath, rtl_uString *pName) SAL_THROW_EXTERN_C()
 Remove a file entry.

Typedef Documentation

typedef void* storeDirectoryHandle

Directory Handle opaque type.

typedef void* storeFileHandle

File Handle opaque type.

typedef void* storeHandle

Handle opaque type.

typedef void* storeStreamHandle

Stream Handle opaque type.


Function Documentation

STORE_DLLPUBLIC storeError store_acquireHandle ( storeHandle  Handle)

Acquire a Handle.

Parameters:
Handle[in] the Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_attrib ( storeFileHandle  hFile,
rtl_uString *  pPath,
rtl_uString *  pName,
sal_uInt32  nMask1,
sal_uInt32  nMask2,
sal_uInt32 *  pnAttrib 
)

Set attributes of a file entry.

Parameters:
hFile[in] the File Handle.
pPath[in] the entry path.
pName[in] the entry name.
nMask1[in] the attributes to be cleared.
nMask2[in] the attributes to be set.
pnAttrib[out] the resulting attributes, may be NULL.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_closeDirectory ( storeDirectoryHandle  hDirectory)

Close a directory.

Parameters:
hDirectory[in] the Directory Handle.
Returns:
store_E_None upon success, store_E_InvalidHandle otherwise.
STORE_DLLPUBLIC storeError store_closeFile ( storeFileHandle  hFile)

Close a file.

Parameters:
hFile[in] the File Handle.
Returns:
store_E_None upon success, store_E_InvalidHandle otherwise.
STORE_DLLPUBLIC storeError store_closeStream ( storeStreamHandle  hStrm)

Close a stream.

Parameters:
hStrm[in] the Stream Handle.
Returns:
store_E_None upon success, store_E_InvalidHandle otherwise.
STORE_DLLPUBLIC storeError store_createMemoryFile ( sal_uInt16  nPageSize,
storeFileHandle phFile 
)

Open a temporary file in memory.

Parameters:
nPageSize[in] the creation page size, integer multiple of minimum page size.
phFile[out] the File Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_findFirst ( storeDirectoryHandle  hDirectory,
storeFindData pFindData 
)

Find first directory entry.

Parameters:
hDirectory[in] the Directory Handle.
pFindData[out] the Find Data structure.
Returns:
store_E_None upon success, store_E_NoMoreFile upon end of iteration.
STORE_DLLPUBLIC storeError store_findNext ( storeDirectoryHandle  hDirectory,
storeFindData pFindData 
)

Find next directory entry.

Parameters:
hDirectory[in] the Directory Handle.
pFindData[out] the Find Data structure.
Returns:
store_E_None upon success, store_E_NoMoreFile upon end of iteration.
STORE_DLLPUBLIC storeError store_flushFile ( storeFileHandle  hFile)

Flush a file.

Parameters:
hFile[in] the File Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_flushStream ( storeStreamHandle  hStrm)

Flush a stream.

Parameters:
hStrm[in] the Stream Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_getFileRefererCount ( storeFileHandle  hFile,
sal_uInt32 *  pnRefCount 
)

Get the number of referers to a file.

Parameters:
hFile[in] the File Handle.
pnRefCount[out] number of open directories and streams.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_getFileSize ( storeFileHandle  hFile,
sal_uInt32 *  pnSize 
)

Get the size of a file.

Parameters:
hFile[in] the File Handle.
pnSize[out] the file size in bytes.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_getStreamSize ( storeStreamHandle  hStrm,
sal_uInt32 *  pnSize 
)

Get the size of a stream.

Parameters:
hStrm[in] the Stream Handle.
pnSize[out] the stream size in bytes.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_link ( storeFileHandle  hFile,
rtl_uString *  pSrcPath,
rtl_uString *  pSrcName,
rtl_uString *  pDstPath,
rtl_uString *  pDstName 
)

Insert a file entry as 'hard link' to another file entry.

Source must not exist, Destination must exist. Source has attribute STORE_ATTRIB_ISLINK.

See also:
store_attrib()
Parameters:
hFile[in] the File Handle
pSrcPath[in] the Source path
pSrcName[in] the Source name
pDstPath[in] the Destination path
pDstName[in] the Destination name
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_openDirectory ( storeFileHandle  hFile,
rtl_uString *  pPath,
rtl_uString *  pName,
storeAccessMode  eAccessMode,
storeDirectoryHandle phDirectory 
)

Open a directory.

See also:
store_openFile()
Parameters:
hFile[in] the File Handle.
pPath[in] the directory path.
pName[in] the directory name.
eAccessMode[in] the access mode.
phDirectory[out] the Directory Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_openFile ( rtl_uString *  pFilename,
storeAccessMode  eAccessMode,
sal_uInt16  nPageSize,
storeFileHandle phFile 
)

Open a file.

Parameters:
pFilename[in] the filename as URL or system path.
eAccessMode[in] the access mode. store_AccessCreate truncate existing and create, store_AccessReadCreate create not existing, store_AccessReadWrite write existing, store_AccessReadOnly never modifies.
nPageSize[in] the creation page size, integer multiple of minimum page size.
phFile[out] the File Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_openStream ( storeFileHandle  hFile,
rtl_uString *  pPath,
rtl_uString *  pName,
storeAccessMode  eMode,
storeStreamHandle phStrm 
)

Open a stream.

See also:
store_openFile()
Parameters:
hFile[in] the File Handle.
pPath[in] the stream path.
pName[in] the stream name.
eMode[in] the access mode.
phStrm[out] the Stream Handle.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_readStream ( storeStreamHandle  hStrm,
sal_uInt32  nOffset,
void *  pBuffer,
sal_uInt32  nBytes,
sal_uInt32 *  pnDone 
)

Read from a stream.

Parameters:
hStrm[in] the Stream Handle.
nOffset[in] the offset of the first byte to read.
pBuffer[out] the buffer.
nBytes[in] the number of bytes to read.
pnDone[out] the number of bytes actually read.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_rebuildFile ( rtl_uString *  pSrcFilename,
rtl_uString *  pDstFilename 
)

Recover and Compact a file into another file.

See also:
store_openFile()
Parameters:
pSrcFilename[in] opened with store_AccessReadOnly.
pDstFilename[in] created with store_AccessCreate.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_releaseHandle ( storeHandle  Handle)

Release a Handle.

Parameters:
Handle[in] the Handle.
Returns:
store_E_None upon success, store_E_InvalidHandle otherwise.
STORE_DLLPUBLIC storeError store_remove ( storeFileHandle  hFile,
rtl_uString *  pPath,
rtl_uString *  pName 
)

Remove a file entry.

Parameters:
hFile[in] the File Handle
pPath[in] the entry path
pName[in] the entry name
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_rename ( storeFileHandle  hFile,
rtl_uString *  pSrcPath,
rtl_uString *  pSrcName,
rtl_uString *  pDstPath,
rtl_uString *  pDstName 
)

Rename a file entry.

Parameters:
hFile[in] the File Handle
pSrcPath[in] the Source path
pSrcName[in] the Source name
pDstPath[in] the Destination path
pDstName[in] the Destination name
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_setStreamSize ( storeStreamHandle  hStrm,
sal_uInt32  nSize 
)

Set the size of a stream.

Parameters:
hStrm[in] the Stream Handle.
nSize[in] the new stream size in bytes.
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_symlink ( storeFileHandle  hFile,
rtl_uString *  pSrcPath,
rtl_uString *  pSrcName,
rtl_uString *  pDstPath,
rtl_uString *  pDstName 
)

Insert a file entry as 'symbolic link' to another file entry.

Source must not exist Source has attribute STORE_ATTRIB_ISLINK.

See also:
store_attrib()
Parameters:
hFile[in] the File Handle
pSrcPath[in] the Source path
pSrcName[in] the Source name
pDstPath[in] the Destination path
pDstName[in] the Destination name
Returns:
store_E_None upon success
STORE_DLLPUBLIC storeError store_writeStream ( storeStreamHandle  hStrm,
sal_uInt32  nOffset,
const void *  pBuffer,
sal_uInt32  nBytes,
sal_uInt32 *  pnDone 
)

Write to a stream.

Parameters:
hStrm[in] the Stream Handle.
nOffset[in] the offset of the first byte to write.
pBuffer[in] the buffer.
nBytes[in] the number of bytes to write.
pnDone[out] the number of bytes actually written.
Returns:
store_E_None upon success
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines