include/store/types.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_STORE_TYPES_H
  21 #define INCLUDED_STORE_TYPES_H
  22
  23 #include <sal/types.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /** PageSize (recommended) default.
  30     @see store_openFile()
  31  */
  32 #define STORE_DEFAULT_PAGESIZE ((sal_uInt16)0x0400)
  33
  34
  35 /** PageSize (enforced) limits.
  36     @see store_openFile()
  37  */
  38 #define STORE_MINIMUM_PAGESIZE ((sal_uInt16)0x0200)
  39 #define STORE_MAXIMUM_PAGESIZE ((sal_uInt16)0x8000)
  40
  41
  42 /** NameSize (enforced) limit.
  43     @see any param pName
  44     @see store_E_NameTooLong
  45  */
  46 #define STORE_MAXIMUM_NAMESIZE 256
  47
  48
  49 /** Attributes (predefined).
  50     @see store_attrib()
  51  */
  52 #define STORE_ATTRIB_ISLINK  ((sal_uInt32)0x10000000)
  53 #define STORE_ATTRIB_ISDIR   ((sal_uInt32)0x20000000)
  54 #define STORE_ATTRIB_ISFILE  ((sal_uInt32)0x40000000)
  55
  56
  57 /** Access Mode enumeration.
  58     @see store_openFile()
  59     @see store_openDirectory()
  60     @see store_openStream()
  61  */
  62 enum class storeAccessMode
  63 {
  64     Create,
  65     ReadWrite,
  66     ReadOnly,
  67     FORCE_EQUAL_SIZE = SAL_MAX_ENUM
  68 };
  69
  70
  71 /** Error Code enumeration.
  72  */
  73 typedef enum
  74 {
  75     store_E_None = 0,
  76     store_E_AccessViolation,
  77     store_E_LockingViolation,
  78     store_E_CantSeek,
  79     store_E_CantRead,
  80     store_E_CantWrite,
  81     store_E_InvalidAccess,
  82     store_E_InvalidHandle,
  83     store_E_InvalidParameter,
  84     store_E_InvalidChecksum,
  85     store_E_AlreadyExists,
  86     store_E_NotExists,
  87     store_E_NotDirectory,
  88     store_E_NotFile,
  89     store_E_NoMoreFiles,
  90     store_E_NameTooLong,
  91     store_E_OutOfMemory,
  92     store_E_OutOfSpace,
  93     store_E_Pending,
  94     store_E_WrongFormat,
  95     store_E_WrongVersion,
  96     store_E_Unknown,
  97     store_E_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
  98 } storeError;
  99
 100
 101 /** Find Data structure.
 102     @see store_findFirst()
 103     @see store_findNext()
 104  */
 105 typedef struct
 106 {
 107     /** Name.
 108         @see m_nLength
 109      */
 110     sal_Unicode m_pszName[STORE_MAXIMUM_NAMESIZE];
 111
 112     /** Name Length.
 113         @see m_pszName
 114      */
 115     sal_Int32 m_nLength;
 116
 117     /** Attributes.
 118         @see store_attrib()
 119      */
 120     sal_uInt32 m_nAttrib;
 121
 122     /** Reserved for internal use.
 123      */
 124     sal_uInt32 m_nReserved;
 125 } storeFindData;
 126
 127 #ifdef __cplusplus
 128 }
 129 #endif
 130
 131 #endif // INCLUDED_STORE_TYPES_H
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */