include/access.idl

   1 /*
   2  * Copyright (C) 2009 Huw Davies
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #if 0
  20 #pragma makedep install
  21 #endif
  22
  23 [
  24     object,
  25     uuid(0c733a8c-2a1c-11ce-ade5-00aa0044773d),
  26     pointer_default(unique)
  27 ]
  28 interface IAccessor : IUnknown
  29 {
  30
  31     typedef DWORD DBACCESSORFLAGS;
  32
  33     typedef DWORD DBBINDSTATUS;
  34
  35     enum DBACCESSORFLAGSENUM
  36     {
  37         DBACCESSOR_INVALID       = 0x00,
  38         DBACCESSOR_PASSBYREF     = 0x01,
  39         DBACCESSOR_ROWDATA       = 0x02,
  40         DBACCESSOR_PARAMETERDATA = 0x04,
  41         DBACCESSOR_OPTIMIZED     = 0x08,
  42         DBACCESSOR_INHERITED     = 0x10,
  43     };
  44
  45     enum DBBINDSTATUSENUM
  46     {
  47         DBBINDSTATUS_OK                    = 0,
  48         DBBINDSTATUS_BADORDINAL            = 1,
  49         DBBINDSTATUS_UNSUPPORTEDCONVERSION = 2,
  50         DBBINDSTATUS_BADBINDINFO           = 3,
  51         DBBINDSTATUS_BADSTORAGEFLAGS       = 4,
  52         DBBINDSTATUS_NOINTERFACE           = 5,
  53         DBBINDSTATUS_MULTIPLESTORAGE       = 6,
  54     };
  55
  56     [local]
  57     HRESULT AddRefAccessor([in] HACCESSOR hAccessor,
  58                            [in, out, unique, annotation("__out_opt")] DBREFCOUNT *pcRefCount);
  59
  60     [call_as(AddRefAccessor)]
  61     HRESULT RemoteAddRefAccessor([in] HACCESSOR hAccessor,
  62                                  [in, out, unique] DBREFCOUNT *pcRefCount,
  63                                  [out] IErrorInfo **ppErrorInfoRem);
  64
  65     [local]
  66     HRESULT CreateAccessor([in] DBACCESSORFLAGS dwAccessorFlags,
  67                            [in] DBCOUNTITEM cBindings,
  68                            [in, size_is(cBindings), annotation("__in_ecount(cBindings)")] const DBBINDING rgBindings[],
  69                            [in] DBLENGTH cbRowSize,
  70                            [out, annotation("__out")] HACCESSOR *phAccessor,
  71                            [out, size_is(cBindings), annotation("__out_ecount_opt(cBindings)")] DBBINDSTATUS rgStatus[]);
  72
  73     [call_as(CreateAccessor)]
  74     HRESULT RemoteCreateAccessor([in] DBACCESSORFLAGS dwAccessorFlags,
  75                                  [in] DBCOUNTITEM cBindings,
  76                                  [in, unique, size_is((ULONG)cBindings)] DBBINDING *rgBindings,
  77                                  [in] DBLENGTH cbRowSize,
  78                                  [out] HACCESSOR *phAccessor,
  79                                  [in, out, unique, size_is((ULONG)cBindings)] DBBINDSTATUS *rgStatus,
  80                                  [out] IErrorInfo **ppErrorInfoRem);
  81
  82     [local]
  83     HRESULT GetBindings([in] HACCESSOR hAccessor,
  84                         [out, annotation("__out")] DBACCESSORFLAGS *pdwAccessorFlags,
  85                         [in, out, annotation("__out_opt")] DBCOUNTITEM *pcBindings,
  86                         [out, size_is(,*pcBindings), annotation("__deref_out_ecount_opt(*pcBindings)")] DBBINDING **prgBindings);
  87
  88     [call_as(GetBindings)]
  89     HRESULT RemoteGetBindings([in] HACCESSOR hAccessor,
  90                               [out] DBACCESSORFLAGS *pdwAccessorFlags,
  91                               [in, out] DBCOUNTITEM *pcBindings,
  92                               [out, size_is(,(ULONG)*pcBindings)] DBBINDING **prgBindings,
  93                               [out] IErrorInfo **ppErrorInfoRem);
  94
  95     [local]
  96     HRESULT ReleaseAccessor([in] HACCESSOR hAccessor,
  97                             [in, out, unique, annotation("__out_opt")] DBREFCOUNT *pcRefCount);
  98
  99     [call_as(ReleaseAccessor)]
 100     HRESULT RemoteReleaseAccessor([in] HACCESSOR hAccessor,
 101                                   [in, out, unique] DBREFCOUNT *pcRefCount,
 102                                   [out] IErrorInfo **ppErrorInfoRem);
 103
 104 }