1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
/*************************************************************************
*
* $RCSfile: store.h,v $
*
* $Revision: 1.1.1.1 $
*
* last change: $Author: hr $ $Date: 2000-09-18 15:18:31 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _STORE_STORE_H_
#define _STORE_STORE_H_ "$Revision: 1.1.1.1 $"
#ifndef _STORE_TYPES_H_
#include <store/types.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/** Opaque type storeHandle.
*/
typedef void* storeHandle;
/** store_acquireHandle.
* @param Handle [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_acquireHandle (storeHandle Handle);
/** store_releaseHandle.
* @param Handle [in]
* @return store_E_None upon success,
* store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_releaseHandle (storeHandle Handle);
/** Opaque type storeFileHandle.
*/
typedef void* storeFileHandle;
/** store_createMemoryFile.
* @param nPageSize [in] the creation page size,
* integer multiple of minimum page size.
* @param phFile [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_createMemoryFile (
sal_uInt16 nPageSize,
storeFileHandle *phFile);
/** store_openFile.
* @param pFilename [in] the filename in host syntax.
* @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]
* @return store_E_None upon success
*/
storeError SAL_CALL store_openFile (
rtl_uString *pFilename,
storeAccessMode eAccessMode,
sal_uInt16 nPageSize,
storeFileHandle *phFile);
/** store_closeFile.
* @param hFile [in]
* @return store_E_None upon success,
* store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeFile (
storeFileHandle hFile);
/** store_flushFile.
* @param hFile [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_flushFile (
storeFileHandle hFile);
/** store_getFileRefererCount.
* @param hFile [in]
* @param pnRefCount [out] number of open directories and streams.
* @return store_E_None upon success
*/
storeError SAL_CALL store_getFileRefererCount (
storeFileHandle hFile,
sal_uInt32 *pnRefCount);
/** store_getFileSize.
* @param hFile [in]
* @param pnSize [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_getFileSize (
storeFileHandle hFile,
sal_uInt32 *pnSize);
/** store_rebuildFile.
* @param pSrcFilename [in] opened with store_AccessReadOnly.
* @param pDstFilename [in] created with store_AccessCreate.
* @return store_E_None upon success
*/
storeError SAL_CALL store_rebuildFile (
rtl_uString *pSrcFilename,
rtl_uString *pDstFilename);
/** Opaque type storeDirectoryHandle.
*/
typedef void* storeDirectoryHandle;
/** store_openDirectory.
* @param hFile [in]
* @param pPath [in]
* @param pName [in]
* @param eAccessMode [in]
* @param phDirectory [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_openDirectory (
storeFileHandle hFile,
rtl_uString *pPath,
rtl_uString *pName,
storeAccessMode eAccessMode,
storeDirectoryHandle *phDirectory);
/** store_closeDirectory.
* @param hDirectory [in]
* @return store_E_None upon success,
* store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeDirectory (
storeDirectoryHandle hDirectory);
/** store_findFirst.
* @param hDirectory [in]
* @param pFindData [out]
* @return store_E_None upon success,
* store_E_NoMoreFile upon end of iteration.
*/
storeError SAL_CALL store_findFirst (
storeDirectoryHandle hDirectory,
storeFindData *pFindData);
/** store_findNext.
* @param hDirectory [in]
* @param pFindData [out]
* @return store_E_None upon success,
* store_E_NoMoreFile upon end of iteration.
*/
storeError SAL_CALL store_findNext (
storeDirectoryHandle hDirectory,
storeFindData *pFindData);
/** Opaque type storeStreamHandle.
*/
typedef void* storeStreamHandle;
/** store_openStream.
* @param hFile [in]
* @param pPath [in]
* @param pName [in]
* @param eAccessMode [in]
* @param phStrm [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_openStream (
storeFileHandle hFile,
rtl_uString *pPath,
rtl_uString *pName,
storeAccessMode eMode,
storeStreamHandle *phStrm);
/** store_closeStream.
* @param hStrm [in]
* @return store_E_None upon success,
* store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeStream (
storeStreamHandle hStrm);
/** store_readStream.
* @param hStrm [in]
* @param nOffset [in]
* @param pBuffer [out]
* @param nBytes [in]
* @param pnDone [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_readStream (
storeStreamHandle hStrm,
sal_uInt32 nOffset,
void *pBuffer,
sal_uInt32 nBytes,
sal_uInt32 *pnDone);
/** store_writeStream.
* @param hStrm [in]
* @param nOffset [in]
* @param pBuffer [in]
* @param nBytes [in]
* @param pnDone [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_writeStream (
storeStreamHandle hStrm,
sal_uInt32 nOffset,
const void *pBuffer,
sal_uInt32 nBytes,
sal_uInt32 *pnDone);
/** store_flushStream.
* @param hStrm [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_flushStream (
storeStreamHandle hStrm);
/** store_getStreamSize.
* @param hStrm [in]
* @param pnSize [out]
* @return store_E_None upon success
*/
storeError SAL_CALL store_getStreamSize (
storeStreamHandle hStrm,
sal_uInt32 *pnSize);
/** store_setStreamSize.
* @param hStrm [in]
* @param nSize [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_setStreamSize (
storeStreamHandle hStrm,
sal_uInt32 nSize);
/** store_attrib.
* @param hFile [in]
* @param pPath [in]
* @param pName [in]
* @param nMask1 [in]
* @param nMask2 [in]
* @param pnAttrib [out] may be NULL.
* @return store_E_None upon success
*/
storeError SAL_CALL store_attrib (
storeFileHandle hFile,
rtl_uString *pPath,
rtl_uString *pName,
sal_uInt32 nMask1,
sal_uInt32 nMask2,
sal_uInt32 *pnAttrib);
/** store_link.
* @param hFile [in]
* @param pSrcPath [in]
* @param pSrcName [in]
* @param pDstPath [in]
* @param pDstName [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_link (
storeFileHandle hFile,
rtl_uString *pSrcPath, rtl_uString *pSrcName,
rtl_uString *pDstPath, rtl_uString *pDstName);
/** store_symlink.
* @param hFile [in]
* @param pSrcPath [in]
* @param pSrcName [in]
* @param pDstPath [in]
* @param pDstName [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_symlink (
storeFileHandle hFile,
rtl_uString *pSrcPath, rtl_uString *pSrcName,
rtl_uString *pDstPath, rtl_uString *pDstName);
/** store_rename.
* @param hFile [in]
* @param pSrcPath [in]
* @param pSrcName [in]
* @param pDstPath [in]
* @param pDstName [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_rename (
storeFileHandle hFile,
rtl_uString *pSrcPath, rtl_uString *pSrcName,
rtl_uString *pDstPath, rtl_uString *pDstName);
/** store_remove.
* @param hFile [in]
* @param pPath [in]
* @param pName [in]
* @return store_E_None upon success
*/
storeError SAL_CALL store_remove (
storeFileHandle hFile,
rtl_uString *pPath,
rtl_uString *pName);
/*========================================================================
*
* The End.
*
*======================================================================*/
#ifdef __cplusplus
}
#endif
#endif /* _STORE_STORE_H_ */
|
