UDK 3.2.7 C/C++ API Reference

store/store.h

Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /*
00003  * This file is part of the LibreOffice project.
00004  *
00005  * This Source Code Form is subject to the terms of the Mozilla Public
00006  * License, v. 2.0. If a copy of the MPL was not distributed with this
00007  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
00008  *
00009  * This file incorporates work covered by the following license notice:
00010  *
00011  *   Licensed to the Apache Software Foundation (ASF) under one or more
00012  *   contributor license agreements. See the NOTICE file distributed
00013  *   with this work for additional information regarding copyright
00014  *   ownership. The ASF licenses this file to you under the Apache
00015  *   License, Version 2.0 (the "License"); you may not use this file
00016  *   except in compliance with the License. You may obtain a copy of
00017  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
00018  */
00019 
00020 #ifndef _STORE_STORE_H_
00021 #define _STORE_STORE_H_
00022 
00023 #include <store/types.h>
00024 #include <store/storedllapi.h>
00025 
00026 #ifdef __cplusplus
00027 extern "C" {
00028 #endif
00029 
00032 typedef void* storeHandle;
00033 
00034 
00039 STORE_DLLPUBLIC storeError SAL_CALL store_acquireHandle (
00040     storeHandle Handle
00041 ) SAL_THROW_EXTERN_C();
00042 
00043 
00049 STORE_DLLPUBLIC storeError SAL_CALL store_releaseHandle (
00050     storeHandle Handle
00051 ) SAL_THROW_EXTERN_C();
00052 
00053 
00054 
00057 typedef void* storeFileHandle;
00058 
00059 
00066 STORE_DLLPUBLIC storeError SAL_CALL store_createMemoryFile (
00067     sal_uInt16       nPageSize,
00068     storeFileHandle *phFile
00069 ) SAL_THROW_EXTERN_C();
00070 
00071 
00084 STORE_DLLPUBLIC storeError SAL_CALL store_openFile (
00085     rtl_uString     *pFilename,
00086     storeAccessMode  eAccessMode,
00087     sal_uInt16       nPageSize,
00088     storeFileHandle *phFile
00089 ) SAL_THROW_EXTERN_C();
00090 
00091 
00097 STORE_DLLPUBLIC storeError SAL_CALL store_closeFile (
00098     storeFileHandle hFile
00099 ) SAL_THROW_EXTERN_C();
00100 
00101 
00106 STORE_DLLPUBLIC storeError SAL_CALL store_flushFile (
00107     storeFileHandle hFile
00108 ) SAL_THROW_EXTERN_C();
00109 
00110 
00116 STORE_DLLPUBLIC storeError SAL_CALL store_getFileRefererCount (
00117     storeFileHandle  hFile,
00118     sal_uInt32      *pnRefCount
00119 ) SAL_THROW_EXTERN_C();
00120 
00121 
00127 STORE_DLLPUBLIC storeError SAL_CALL store_getFileSize (
00128     storeFileHandle  hFile,
00129     sal_uInt32      *pnSize
00130 ) SAL_THROW_EXTERN_C();
00131 
00132 
00140 STORE_DLLPUBLIC storeError SAL_CALL store_rebuildFile (
00141     rtl_uString *pSrcFilename,
00142     rtl_uString *pDstFilename
00143 ) SAL_THROW_EXTERN_C();
00144 
00145 
00146 
00149 typedef void* storeDirectoryHandle;
00150 
00151 
00162 STORE_DLLPUBLIC storeError SAL_CALL store_openDirectory (
00163     storeFileHandle       hFile,
00164     rtl_uString          *pPath,
00165     rtl_uString          *pName,
00166     storeAccessMode       eAccessMode,
00167     storeDirectoryHandle *phDirectory
00168 ) SAL_THROW_EXTERN_C();
00169 
00170 
00176 STORE_DLLPUBLIC storeError SAL_CALL store_closeDirectory (
00177     storeDirectoryHandle hDirectory
00178 ) SAL_THROW_EXTERN_C();
00179 
00180 
00187 STORE_DLLPUBLIC storeError SAL_CALL store_findFirst (
00188     storeDirectoryHandle  hDirectory,
00189     storeFindData        *pFindData
00190 ) SAL_THROW_EXTERN_C();
00191 
00192 
00199 STORE_DLLPUBLIC storeError SAL_CALL store_findNext (
00200     storeDirectoryHandle  hDirectory,
00201     storeFindData        *pFindData
00202 ) SAL_THROW_EXTERN_C();
00203 
00204 
00205 
00208 typedef void* storeStreamHandle;
00209 
00210 
00221 STORE_DLLPUBLIC storeError SAL_CALL store_openStream (
00222     storeFileHandle    hFile,
00223     rtl_uString       *pPath,
00224     rtl_uString       *pName,
00225     storeAccessMode    eMode,
00226     storeStreamHandle *phStrm
00227 ) SAL_THROW_EXTERN_C();
00228 
00229 
00235 STORE_DLLPUBLIC storeError SAL_CALL store_closeStream (
00236     storeStreamHandle hStrm
00237 ) SAL_THROW_EXTERN_C();
00238 
00239 
00248 STORE_DLLPUBLIC storeError SAL_CALL store_readStream (
00249     storeStreamHandle  hStrm,
00250     sal_uInt32         nOffset,
00251     void              *pBuffer,
00252     sal_uInt32         nBytes,
00253     sal_uInt32        *pnDone
00254 ) SAL_THROW_EXTERN_C();
00255 
00256 
00265 STORE_DLLPUBLIC storeError SAL_CALL store_writeStream (
00266     storeStreamHandle  hStrm,
00267     sal_uInt32         nOffset,
00268     const void        *pBuffer,
00269     sal_uInt32         nBytes,
00270     sal_uInt32        *pnDone
00271 ) SAL_THROW_EXTERN_C();
00272 
00273 
00278 STORE_DLLPUBLIC storeError SAL_CALL store_flushStream (
00279     storeStreamHandle hStrm
00280 ) SAL_THROW_EXTERN_C();
00281 
00282 
00288 STORE_DLLPUBLIC storeError SAL_CALL store_getStreamSize (
00289     storeStreamHandle  hStrm,
00290     sal_uInt32        *pnSize
00291 ) SAL_THROW_EXTERN_C();
00292 
00293 
00299 STORE_DLLPUBLIC storeError SAL_CALL store_setStreamSize (
00300     storeStreamHandle hStrm,
00301     sal_uInt32        nSize
00302 ) SAL_THROW_EXTERN_C();
00303 
00304 
00305 
00315 STORE_DLLPUBLIC storeError SAL_CALL store_attrib (
00316     storeFileHandle hFile,
00317     rtl_uString    *pPath,
00318     rtl_uString    *pName,
00319     sal_uInt32      nMask1,
00320     sal_uInt32      nMask2,
00321     sal_uInt32     *pnAttrib
00322 ) SAL_THROW_EXTERN_C();
00323 
00324 
00337 STORE_DLLPUBLIC storeError SAL_CALL store_link (
00338     storeFileHandle hFile,
00339     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00340     rtl_uString *pDstPath, rtl_uString *pDstName
00341 ) SAL_THROW_EXTERN_C();
00342 
00343 
00356 STORE_DLLPUBLIC storeError SAL_CALL store_symlink (
00357     storeFileHandle hFile,
00358     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00359     rtl_uString *pDstPath, rtl_uString *pDstName
00360 ) SAL_THROW_EXTERN_C();
00361 
00362 
00371 STORE_DLLPUBLIC storeError SAL_CALL store_rename (
00372     storeFileHandle hFile,
00373     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00374     rtl_uString *pDstPath, rtl_uString *pDstName
00375 ) SAL_THROW_EXTERN_C();
00376 
00377 
00384 STORE_DLLPUBLIC storeError SAL_CALL store_remove (
00385     storeFileHandle hFile,
00386     rtl_uString    *pPath,
00387     rtl_uString    *pName
00388 ) SAL_THROW_EXTERN_C();
00389 
00390 /*========================================================================
00391  *
00392  * The End.
00393  *
00394  *======================================================================*/
00395 
00396 #ifdef __cplusplus
00397 }
00398 #endif
00399 
00400 #endif /* _STORE_STORE_H_ */
00401 
00402 
00403 
00404 
00405 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines