#include <store/storedllapi.h>
#include <store/types.h>
#include <rtl/ustring.h>
#include <sal/types.h>

Include dependency graph for store.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef void *	storeHandle
	Handle opaque type. More...

typedef void *	storeFileHandle
	File Handle opaque type. More...

typedef void *	storeDirectoryHandle
	Directory Handle opaque type. More...

typedef void *	storeStreamHandle
	Stream Handle opaque type. More...

Functions
STORE_DLLPUBLIC storeError	store_acquireHandle (storeHandle Handle) SAL_THROW_EXTERN_C()
	Acquire a Handle. More...

STORE_DLLPUBLIC storeError	store_releaseHandle (storeHandle Handle) SAL_THROW_EXTERN_C()
	Release a Handle. More...

STORE_DLLPUBLIC storeError	store_createMemoryFile (sal_uInt16 nPageSize, storeFileHandle *phFile) SAL_THROW_EXTERN_C()
	Open a temporary file in memory. More...

STORE_DLLPUBLIC storeError	store_openFile (rtl_uString pFilename, storeAccessMode eAccessMode, sal_uInt16 nPageSize, storeFileHandle phFile) SAL_THROW_EXTERN_C()
	Open a file. More...

STORE_DLLPUBLIC storeError	store_closeFile (storeFileHandle hFile) SAL_THROW_EXTERN_C()
	Close a file. More...

STORE_DLLPUBLIC storeError	store_flushFile (storeFileHandle hFile) SAL_THROW_EXTERN_C()
	Flush a file. More...

STORE_DLLPUBLIC storeError	store_openDirectory (storeFileHandle hFile, rtl_uString const pPath, rtl_uString const pName, storeAccessMode eAccessMode, storeDirectoryHandle *phDirectory) SAL_THROW_EXTERN_C()
	Open a directory. More...

STORE_DLLPUBLIC storeError	store_findFirst (storeDirectoryHandle hDirectory, storeFindData *pFindData) SAL_THROW_EXTERN_C()
	Find first directory entry. More...

STORE_DLLPUBLIC storeError	store_findNext (storeDirectoryHandle hDirectory, storeFindData *pFindData) SAL_THROW_EXTERN_C()
	Find next directory entry. More...

STORE_DLLPUBLIC storeError	store_openStream (storeFileHandle hFile, rtl_uString const pPath, rtl_uString const pName, storeAccessMode eMode, storeStreamHandle *phStrm) SAL_THROW_EXTERN_C()
	Open a stream. More...

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. More...

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. More...

STORE_DLLPUBLIC storeError	store_remove (storeFileHandle hFile, rtl_uString const pPath, rtl_uString const pName) SAL_THROW_EXTERN_C()
	Remove a file entry. More...

Typedef Documentation

◆ storeDirectoryHandle

typedef void* storeDirectoryHandle

Directory Handle opaque type.

Definition at line 105 of file store.h.

◆ storeFileHandle

typedef void* storeFileHandle

File Handle opaque type.

Definition at line 54 of file store.h.

◆ storeHandle

typedef void* storeHandle

Handle opaque type.

Definition at line 33 of file store.h.

◆ storeStreamHandle

typedef void* storeStreamHandle

Stream Handle opaque type.

Definition at line 149 of file store.h.

Function Documentation

◆ store_acquireHandle()

STORE_DLLPUBLIC storeError store_acquireHandle ( storeHandle Handle )

Acquire a Handle.

Parameters

Handle [in] the Handle.

Returns: store_E_None upon success

Definition at line 65 of file store.cxx.

References salhelper::SimpleReferenceObject::acquire(), Handle, SAL_THROW_EXTERN_C, store_E_InvalidHandle, and store_E_None.

Referenced by store::OStoreDirectory::operator=(), store::OStoreFile::operator=(), store::OStoreStream::operator=(), store::OStoreDirectory::OStoreDirectory(), store::OStoreFile::OStoreFile(), and store::OStoreStream::OStoreStream().

◆ store_closeFile()

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.

Definition at line 158 of file store.cxx.

References store::OStorePageBIOS::close(), Handle, store::query(), salhelper::SimpleReferenceObject::release(), SAL_THROW_EXTERN_C, and store_E_InvalidHandle.

Referenced by store::OStoreFile::close().

◆ store_createMemoryFile()

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

Definition at line 89 of file store.cxx.

References Create, store::MemoryLockBytes_createInstance(), SAL_THROW_EXTERN_C, store_E_InvalidParameter, store_E_None, and store_E_OutOfMemory.

Referenced by store::OStoreFile::createInMemory().

◆ store_findFirst()

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.

Definition at line 221 of file store.cxx.

References Handle, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, and store_E_InvalidParameter.

Referenced by store::OStoreDirectory::first().

◆ store_findNext()

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.

Definition at line 242 of file store.cxx.

References Handle, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, store_E_InvalidParameter, and store_E_NoMoreFiles.

Referenced by store::OStoreDirectory::next().

◆ store_flushFile()

STORE_DLLPUBLIC storeError store_flushFile ( storeFileHandle hFile )

Flush a file.

Parameters

hFile [in] the File Handle.

Returns: store_E_None upon success

Definition at line 172 of file store.cxx.

References Handle, store::query(), SAL_THROW_EXTERN_C, and store_E_InvalidHandle.

Referenced by store::OStoreFile::flush().

◆ store_openDirectory()

STORE_DLLPUBLIC storeError store_openDirectory	(	storeFileHandle	hFile,
		rtl_uString const *	pPath,
		rtl_uString const *	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

Definition at line 184 of file store.cxx.

References aName, pName, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, store_E_InvalidParameter, store_E_None, and store_E_OutOfMemory.

Referenced by store::OStoreDirectory::create().

◆ store_openFile()

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. storeAccessMode::Create truncate existing and create, store_AccessReadCreate create not existing, storeAccessMode::ReadWrite write existing, storeAccessMode::ReadOnly 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

Definition at line 120 of file store.cxx.

References store::FileLockBytes_createInstance(), SAL_THROW_EXTERN_C, store_E_InvalidParameter, store_E_None, and store_E_OutOfMemory.

Referenced by store::OStoreFile::create().

◆ store_openStream()

STORE_DLLPUBLIC storeError store_openStream	(	storeFileHandle	hFile,
		rtl_uString const *	pPath,
		rtl_uString const *	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

Definition at line 264 of file store.cxx.

References aName, pName, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, store_E_InvalidParameter, store_E_None, and store_E_OutOfMemory.

Referenced by store::OStoreStream::create().

◆ store_readStream()

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

Definition at line 304 of file store.cxx.

References Handle, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, and store_E_InvalidParameter.

Referenced by store::OStoreStream::readAt().

◆ store_releaseHandle()

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.

Definition at line 77 of file store.cxx.

References Handle, salhelper::SimpleReferenceObject::release(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, and store_E_None.

Referenced by store::OStoreFile::create(), store::OStoreStream::create(), store::OStoreDirectory::create(), store::OStoreFile::createInMemory(), store::OStoreDirectory::operator=(), store::OStoreFile::operator=(), store::OStoreStream::operator=(), store::OStoreDirectory::~OStoreDirectory(), store::OStoreFile::~OStoreFile(), and store::OStoreStream::~OStoreStream().

◆ store_remove()

STORE_DLLPUBLIC storeError store_remove	(	storeFileHandle	hFile,
		rtl_uString const *	pPath,
		rtl_uString const *	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

Definition at line 342 of file store.cxx.

References aName, Handle, pName, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, store_E_InvalidParameter, and store_E_None.

Referenced by store::OStoreFile::remove().

◆ store_writeStream()

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

Definition at line 323 of file store.cxx.

References Handle, store::query(), SAL_THROW_EXTERN_C, store_E_InvalidHandle, and store_E_InvalidParameter.

Referenced by store::OStoreStream::writeAt().

Typedefs

Functions

Typedef Documentation

◆ storeDirectoryHandle

◆ storeFileHandle

◆ storeHandle

◆ storeStreamHandle

Function Documentation

◆ store_acquireHandle()

◆ store_closeFile()

◆ store_createMemoryFile()

◆ store_findFirst()

◆ store_findNext()

◆ store_flushFile()

◆ store_openDirectory()

◆ store_openFile()

◆ store_openStream()

◆ store_readStream()

◆ store_releaseHandle()

◆ store_remove()

◆ store_writeStream()