include/rstloc.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     local,
  25     object,
  26     uuid(0c733a7d-2a1c-11ce-ade5-00aa0044773d),
  27     pointer_default(unique)
  28 ]
  29 interface IRowsetLocate : IRowset
  30 {
  31     typedef DWORD DBCOMPARE;
  32
  33     enum DBCOMPAREENUM
  34     {
  35         DBCOMPARE_LT,
  36         DBCOMPARE_EQ,
  37         DBCOMPARE_GT,
  38         DBCOMPARE_NE,
  39         DBCOMPARE_NOTCOMPARABLE
  40     };
  41
  42     HRESULT Compare([in] HCHAPTER hReserved,
  43                     [in] DBBKMARK cbBookmark1,
  44                     [in, size_is(cbBookmark1)] const BYTE *pBookmark1,
  45                     [in] DBBKMARK cbBookmark2,
  46                     [in, size_is(cbBookmark2)] const BYTE *pBookmark2,
  47                     [out] DBCOMPARE *pComparison);
  48
  49     HRESULT GetRowsAt([in] HWATCHREGION hReserved1,
  50                       [in] HCHAPTER hReserved2,
  51                       [in] DBBKMARK cbBookmark,
  52                       [in, size_is(cbBookmark)] const BYTE *pBookmark,
  53                       [in] DBROWOFFSET lRowsOffset,
  54                       [in] DBROWCOUNT cRows,
  55                       [out] DBCOUNTITEM *pcRowsObtained,
  56                       [out, size_is(,cRows)] HROW **prghRows);
  57
  58     HRESULT GetRowsByBookmark([in] HCHAPTER hReserved,
  59                               [in] DBCOUNTITEM cRows,
  60                               [in, size_is(cRows)] const DBBKMARK rgcbBookmarks[],
  61                               [in, size_is(cRows)] const BYTE *rgpBookmarks[],
  62                               [out, size_is(cRows)] HROW rghRows[],
  63                               [out, size_is(cRows)] DBROWSTATUS rgRowStatus[]);
  64
  65     HRESULT Hash([in] HCHAPTER hReserved,
  66                  [in] DBBKMARK cBookmarks,
  67                  [in, size_is(cBookmarks)] const DBBKMARK rgcbBookmarks[],
  68                  [in, size_is(cBookmarks)] const BYTE *rgpBookmarks[],
  69                  [out, size_is(cBookmarks)] DBHASHVALUE rgHashedValues[],
  70                  [out, size_is(cBookmarks)] DBROWSTATUS rgBookmarkStatus[]);
  71 }