summaryrefslogtreecommitdiff
path: root/store/inc/store/store.h
diff options
context:
space:
mode:
authorBjoern Michaelsen <bjoern.michaelsen@canonical.com>2013-04-18 18:26:28 +0200
committerBjoern Michaelsen <bjoern.michaelsen@canonical.com>2013-04-23 22:20:31 +0200
commitb9337e22ce1dbf2eba0e8c8db294ae99f4111f91 (patch)
tree53ee1bd3dfd213815a21579151983cb997922b05 /store/inc/store/store.h
parentf4e1642a1761d5eab6ccdd89928869c2b2f1528a (diff)
execute move of global headers
see https://gerrit.libreoffice.org/#/c/3367/ and Change-Id: I00c96fa77d04b33a6f8c8cd3490dfcd9bdc9e84a for details Change-Id: I199a75bc4042af20817265d5ef85b1134a96ff5a
Diffstat (limited to 'store/inc/store/store.h')
-rw-r--r--store/inc/store/store.h405
1 files changed, 0 insertions, 405 deletions
diff --git a/store/inc/store/store.h b/store/inc/store/store.h
deleted file mode 100644
index ff3f1ef0a390..000000000000
--- a/store/inc/store/store.h
+++ /dev/null
@@ -1,405 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.apache.org/licenses/LICENSE-2.0 .
- */
-
-#ifndef _STORE_STORE_H_
-#define _STORE_STORE_H_
-
-#include <store/types.h>
-#include <store/storedllapi.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Handle opaque type.
- */
-typedef void* storeHandle;
-
-
-/** Acquire a Handle.
- @param Handle [in] the Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_acquireHandle (
- storeHandle Handle
-) SAL_THROW_EXTERN_C();
-
-
-/** Release a Handle.
- @param Handle [in] the Handle.
- @return store_E_None upon success,
- store_E_InvalidHandle otherwise.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_releaseHandle (
- storeHandle Handle
-) SAL_THROW_EXTERN_C();
-
-
-
-/** File Handle opaque type.
- */
-typedef void* storeFileHandle;
-
-
-/** Open a temporary file in memory.
- @param nPageSize [in] the creation page size,
- integer multiple of minimum page size.
- @param phFile [out] the File Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_createMemoryFile (
- sal_uInt16 nPageSize,
- storeFileHandle *phFile
-) SAL_THROW_EXTERN_C();
-
-
-/** Open a file.
- @param pFilename [in] the filename as URL or system path.
- @param eAccessMode [in] the access mode.
- store_AccessCreate truncate existing and create,
- store_AccessReadCreate create not existing,
- store_AccessReadWrite write existing,
- store_AccessReadOnly never modifies.
- @param nPageSize [in] the creation page size,
- integer multiple of minimum page size.
- @param phFile [out] the File Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_openFile (
- rtl_uString *pFilename,
- storeAccessMode eAccessMode,
- sal_uInt16 nPageSize,
- storeFileHandle *phFile
-) SAL_THROW_EXTERN_C();
-
-
-/** Close a file.
- @param hFile [in] the File Handle.
- @return store_E_None upon success,
- store_E_InvalidHandle otherwise.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_closeFile (
- storeFileHandle hFile
-) SAL_THROW_EXTERN_C();
-
-
-/** Flush a file.
- @param hFile [in] the File Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_flushFile (
- storeFileHandle hFile
-) SAL_THROW_EXTERN_C();
-
-
-/** Get the number of referers to a file.
- @param hFile [in] the File Handle.
- @param pnRefCount [out] number of open directories and streams.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_getFileRefererCount (
- storeFileHandle hFile,
- sal_uInt32 *pnRefCount
-) SAL_THROW_EXTERN_C();
-
-
-/** Get the size of a file.
- @param hFile [in] the File Handle.
- @param pnSize [out] the file size in bytes.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_getFileSize (
- storeFileHandle hFile,
- sal_uInt32 *pnSize
-) SAL_THROW_EXTERN_C();
-
-
-/** Recover and Compact a file into another file.
- @see store_openFile()
-
- @param pSrcFilename [in] opened with store_AccessReadOnly.
- @param pDstFilename [in] created with store_AccessCreate.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_rebuildFile (
- rtl_uString *pSrcFilename,
- rtl_uString *pDstFilename
-) SAL_THROW_EXTERN_C();
-
-
-
-/** Directory Handle opaque type.
- */
-typedef void* storeDirectoryHandle;
-
-
-/** Open a directory.
- @see store_openFile()
-
- @param hFile [in] the File Handle.
- @param pPath [in] the directory path.
- @param pName [in] the directory name.
- @param eAccessMode [in] the access mode.
- @param phDirectory [out] the Directory Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_openDirectory (
- storeFileHandle hFile,
- rtl_uString *pPath,
- rtl_uString *pName,
- storeAccessMode eAccessMode,
- storeDirectoryHandle *phDirectory
-) SAL_THROW_EXTERN_C();
-
-
-/** Close a directory.
- @param hDirectory [in] the Directory Handle.
- @return store_E_None upon success,
- store_E_InvalidHandle otherwise.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_closeDirectory (
- storeDirectoryHandle hDirectory
-) SAL_THROW_EXTERN_C();
-
-
-/** Find first directory entry.
- @param hDirectory [in] the Directory Handle.
- @param pFindData [out] the Find Data structure.
- @return store_E_None upon success,
- store_E_NoMoreFile upon end of iteration.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_findFirst (
- storeDirectoryHandle hDirectory,
- storeFindData *pFindData
-) SAL_THROW_EXTERN_C();
-
-
-/** Find next directory entry.
- @param hDirectory [in] the Directory Handle.
- @param pFindData [out] the Find Data structure.
- @return store_E_None upon success,
- store_E_NoMoreFile upon end of iteration.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_findNext (
- storeDirectoryHandle hDirectory,
- storeFindData *pFindData
-) SAL_THROW_EXTERN_C();
-
-
-
-/** Stream Handle opaque type.
- */
-typedef void* storeStreamHandle;
-
-
-/** Open a stream.
- @see store_openFile()
-
- @param hFile [in] the File Handle.
- @param pPath [in] the stream path.
- @param pName [in] the stream name.
- @param eMode [in] the access mode.
- @param phStrm [out] the Stream Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_openStream (
- storeFileHandle hFile,
- rtl_uString *pPath,
- rtl_uString *pName,
- storeAccessMode eMode,
- storeStreamHandle *phStrm
-) SAL_THROW_EXTERN_C();
-
-
-/** Close a stream.
- @param hStrm [in] the Stream Handle.
- @return store_E_None upon success,
- store_E_InvalidHandle otherwise.
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_closeStream (
- storeStreamHandle hStrm
-) SAL_THROW_EXTERN_C();
-
-
-/** Read from a stream.
- @param hStrm [in] the Stream Handle.
- @param nOffset [in] the offset of the first byte to read.
- @param pBuffer [out] the buffer.
- @param nBytes [in] the number of bytes to read.
- @param pnDone [out] the number of bytes actually read.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_readStream (
- storeStreamHandle hStrm,
- sal_uInt32 nOffset,
- void *pBuffer,
- sal_uInt32 nBytes,
- sal_uInt32 *pnDone
-) SAL_THROW_EXTERN_C();
-
-
-/** Write to a stream.
- @param hStrm [in] the Stream Handle.
- @param nOffset [in] the offset of the first byte to write.
- @param pBuffer [in] the buffer.
- @param nBytes [in] the number of bytes to write.
- @param pnDone [out] the number of bytes actually written.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_writeStream (
- storeStreamHandle hStrm,
- sal_uInt32 nOffset,
- const void *pBuffer,
- sal_uInt32 nBytes,
- sal_uInt32 *pnDone
-) SAL_THROW_EXTERN_C();
-
-
-/** Flush a stream.
- @param hStrm [in] the Stream Handle.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_flushStream (
- storeStreamHandle hStrm
-) SAL_THROW_EXTERN_C();
-
-
-/** Get the size of a stream.
- @param hStrm [in] the Stream Handle.
- @param pnSize [out] the stream size in bytes.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_getStreamSize (
- storeStreamHandle hStrm,
- sal_uInt32 *pnSize
-) SAL_THROW_EXTERN_C();
-
-
-/** Set the size of a stream.
- @param hStrm [in] the Stream Handle.
- @param nSize [in] the new stream size in bytes.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_setStreamSize (
- storeStreamHandle hStrm,
- sal_uInt32 nSize
-) SAL_THROW_EXTERN_C();
-
-
-
-/** Set attributes of a file entry.
- @param hFile [in] the File Handle.
- @param pPath [in] the entry path.
- @param pName [in] the entry name.
- @param nMask1 [in] the attributes to be cleared.
- @param nMask2 [in] the attributes to be set.
- @param pnAttrib [out] the resulting attributes, may be NULL.
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_attrib (
- storeFileHandle hFile,
- rtl_uString *pPath,
- rtl_uString *pName,
- sal_uInt32 nMask1,
- sal_uInt32 nMask2,
- sal_uInt32 *pnAttrib
-) SAL_THROW_EXTERN_C();
-
-
-/** Insert a file entry as 'hard link' to another file entry.
- @pre Source must not exist, Destination must exist.
- @post Source has attribute STORE_ATTRIB_ISLINK.
- @see store_attrib()
-
- @param hFile [in] the File Handle
- @param pSrcPath [in] the Source path
- @param pSrcName [in] the Source name
- @param pDstPath [in] the Destination path
- @param pDstName [in] the Destination name
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL 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 'symbolic link' to another file entry.
- @pre Source must not exist
- @post Source has attribute STORE_ATTRIB_ISLINK.
- @see store_attrib()
-
- @param hFile [in] the File Handle
- @param pSrcPath [in] the Source path
- @param pSrcName [in] the Source name
- @param pDstPath [in] the Destination path
- @param pDstName [in] the Destination name
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_symlink (
- storeFileHandle hFile,
- rtl_uString *pSrcPath, rtl_uString *pSrcName,
- rtl_uString *pDstPath, rtl_uString *pDstName
-) SAL_THROW_EXTERN_C();
-
-
-/** Rename a file entry.
- @param hFile [in] the File Handle
- @param pSrcPath [in] the Source path
- @param pSrcName [in] the Source name
- @param pDstPath [in] the Destination path
- @param pDstName [in] the Destination name
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_rename (
- storeFileHandle hFile,
- rtl_uString *pSrcPath, rtl_uString *pSrcName,
- rtl_uString *pDstPath, rtl_uString *pDstName
-) SAL_THROW_EXTERN_C();
-
-
-/** Remove a file entry.
- @param hFile [in] the File Handle
- @param pPath [in] the entry path
- @param pName [in] the entry name
- @return store_E_None upon success
- */
-STORE_DLLPUBLIC storeError SAL_CALL store_remove (
- storeFileHandle hFile,
- rtl_uString *pPath,
- rtl_uString *pName
-) SAL_THROW_EXTERN_C();
-
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* _STORE_STORE_H_ */
-
-
-
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */