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  *
00004  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
00005  *
00006  * Copyright 2000, 2010 Oracle and/or its affiliates.
00007  *
00008  * OpenOffice.org - a multi-platform office productivity suite
00009  *
00010  * This file is part of OpenOffice.org.
00011  *
00012  * OpenOffice.org is free software: you can redistribute it and/or modify
00013  * it under the terms of the GNU Lesser General Public License version 3
00014  * only, as published by the Free Software Foundation.
00015  *
00016  * OpenOffice.org is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Lesser General Public License version 3 for more details
00020  * (a copy is included in the LICENSE file that accompanied this code).
00021  *
00022  * You should have received a copy of the GNU Lesser General Public License
00023  * version 3 along with OpenOffice.org.  If not, see
00024  * <http://www.openoffice.org/license.html>
00025  * for a copy of the LGPLv3 License.
00026  *
00027  ************************************************************************/
00028 
00029 #ifndef _STORE_STORE_H_
00030 #define _STORE_STORE_H_
00031 
00032 #include <store/types.h>
00033 #include <store/storedllapi.h>
00034 
00035 #ifdef __cplusplus
00036 extern "C" {
00037 #endif
00038 
00041 typedef void* storeHandle;
00042 
00043 
00048 STORE_DLLPUBLIC storeError SAL_CALL store_acquireHandle (
00049     storeHandle Handle
00050 ) SAL_THROW_EXTERN_C();
00051 
00052 
00058 STORE_DLLPUBLIC storeError SAL_CALL store_releaseHandle (
00059     storeHandle Handle
00060 ) SAL_THROW_EXTERN_C();
00061 
00062 
00063 
00066 typedef void* storeFileHandle;
00067 
00068 
00075 STORE_DLLPUBLIC storeError SAL_CALL store_createMemoryFile (
00076     sal_uInt16       nPageSize,
00077     storeFileHandle *phFile
00078 ) SAL_THROW_EXTERN_C();
00079 
00080 
00093 STORE_DLLPUBLIC storeError SAL_CALL store_openFile (
00094     rtl_uString     *pFilename,
00095     storeAccessMode  eAccessMode,
00096     sal_uInt16       nPageSize,
00097     storeFileHandle *phFile
00098 ) SAL_THROW_EXTERN_C();
00099 
00100 
00106 STORE_DLLPUBLIC storeError SAL_CALL store_closeFile (
00107     storeFileHandle hFile
00108 ) SAL_THROW_EXTERN_C();
00109 
00110 
00115 STORE_DLLPUBLIC storeError SAL_CALL store_flushFile (
00116     storeFileHandle hFile
00117 ) SAL_THROW_EXTERN_C();
00118 
00119 
00125 STORE_DLLPUBLIC storeError SAL_CALL store_getFileRefererCount (
00126     storeFileHandle  hFile,
00127     sal_uInt32      *pnRefCount
00128 ) SAL_THROW_EXTERN_C();
00129 
00130 
00136 STORE_DLLPUBLIC storeError SAL_CALL store_getFileSize (
00137     storeFileHandle  hFile,
00138     sal_uInt32      *pnSize
00139 ) SAL_THROW_EXTERN_C();
00140 
00141 
00149 STORE_DLLPUBLIC storeError SAL_CALL store_rebuildFile (
00150     rtl_uString *pSrcFilename,
00151     rtl_uString *pDstFilename
00152 ) SAL_THROW_EXTERN_C();
00153 
00154 
00155 
00158 typedef void* storeDirectoryHandle;
00159 
00160 
00171 STORE_DLLPUBLIC storeError SAL_CALL store_openDirectory (
00172     storeFileHandle       hFile,
00173     rtl_uString          *pPath,
00174     rtl_uString          *pName,
00175     storeAccessMode       eAccessMode,
00176     storeDirectoryHandle *phDirectory
00177 ) SAL_THROW_EXTERN_C();
00178 
00179 
00185 STORE_DLLPUBLIC storeError SAL_CALL store_closeDirectory (
00186     storeDirectoryHandle hDirectory
00187 ) SAL_THROW_EXTERN_C();
00188 
00189 
00196 STORE_DLLPUBLIC storeError SAL_CALL store_findFirst (
00197     storeDirectoryHandle  hDirectory,
00198     storeFindData        *pFindData
00199 ) SAL_THROW_EXTERN_C();
00200 
00201 
00208 STORE_DLLPUBLIC storeError SAL_CALL store_findNext (
00209     storeDirectoryHandle  hDirectory,
00210     storeFindData        *pFindData
00211 ) SAL_THROW_EXTERN_C();
00212 
00213 
00214 
00217 typedef void* storeStreamHandle;
00218 
00219 
00230 STORE_DLLPUBLIC storeError SAL_CALL store_openStream (
00231     storeFileHandle    hFile,
00232     rtl_uString       *pPath,
00233     rtl_uString       *pName,
00234     storeAccessMode    eMode,
00235     storeStreamHandle *phStrm
00236 ) SAL_THROW_EXTERN_C();
00237 
00238 
00244 STORE_DLLPUBLIC storeError SAL_CALL store_closeStream (
00245     storeStreamHandle hStrm
00246 ) SAL_THROW_EXTERN_C();
00247 
00248 
00257 STORE_DLLPUBLIC storeError SAL_CALL store_readStream (
00258     storeStreamHandle  hStrm,
00259     sal_uInt32         nOffset,
00260     void              *pBuffer,
00261     sal_uInt32         nBytes,
00262     sal_uInt32        *pnDone
00263 ) SAL_THROW_EXTERN_C();
00264 
00265 
00274 STORE_DLLPUBLIC storeError SAL_CALL store_writeStream (
00275     storeStreamHandle  hStrm,
00276     sal_uInt32         nOffset,
00277     const void        *pBuffer,
00278     sal_uInt32         nBytes,
00279     sal_uInt32        *pnDone
00280 ) SAL_THROW_EXTERN_C();
00281 
00282 
00287 STORE_DLLPUBLIC storeError SAL_CALL store_flushStream (
00288     storeStreamHandle hStrm
00289 ) SAL_THROW_EXTERN_C();
00290 
00291 
00297 STORE_DLLPUBLIC storeError SAL_CALL store_getStreamSize (
00298     storeStreamHandle  hStrm,
00299     sal_uInt32        *pnSize
00300 ) SAL_THROW_EXTERN_C();
00301 
00302 
00308 STORE_DLLPUBLIC storeError SAL_CALL store_setStreamSize (
00309     storeStreamHandle hStrm,
00310     sal_uInt32        nSize
00311 ) SAL_THROW_EXTERN_C();
00312 
00313 
00314 
00324 STORE_DLLPUBLIC storeError SAL_CALL store_attrib (
00325     storeFileHandle hFile,
00326     rtl_uString    *pPath,
00327     rtl_uString    *pName,
00328     sal_uInt32      nMask1,
00329     sal_uInt32      nMask2,
00330     sal_uInt32     *pnAttrib
00331 ) SAL_THROW_EXTERN_C();
00332 
00333 
00346 STORE_DLLPUBLIC storeError SAL_CALL store_link (
00347     storeFileHandle hFile,
00348     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00349     rtl_uString *pDstPath, rtl_uString *pDstName
00350 ) SAL_THROW_EXTERN_C();
00351 
00352 
00365 STORE_DLLPUBLIC storeError SAL_CALL store_symlink (
00366     storeFileHandle hFile,
00367     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00368     rtl_uString *pDstPath, rtl_uString *pDstName
00369 ) SAL_THROW_EXTERN_C();
00370 
00371 
00380 STORE_DLLPUBLIC storeError SAL_CALL store_rename (
00381     storeFileHandle hFile,
00382     rtl_uString *pSrcPath, rtl_uString *pSrcName,
00383     rtl_uString *pDstPath, rtl_uString *pDstName
00384 ) SAL_THROW_EXTERN_C();
00385 
00386 
00393 STORE_DLLPUBLIC storeError SAL_CALL store_remove (
00394     storeFileHandle hFile,
00395     rtl_uString    *pPath,
00396     rtl_uString    *pName
00397 ) SAL_THROW_EXTERN_C();
00398 
00399 /*========================================================================
00400  *
00401  * The End.
00402  *
00403  *======================================================================*/
00404 
00405 #ifdef __cplusplus
00406 }
00407 #endif
00408 
00409 #endif /* _STORE_STORE_H_ */
00410 
00411 
00412 
00413 
00414 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines