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