| FDO API Reference | Feature Data Objects |
00001 #ifndef _ILONGTRANSACTIONSETREADER_H_ 00002 #define _ILONGTRANSACTIONSETREADER_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 #include <Fdo/Commands/LongTransaction/LongTransactionConstants.h> 00028 00029 /// \brief 00030 /// The FdoILongTransactionSetReader interface provides forward only, read-only 00031 /// functionality for enumerating the versions in the long transaction selection 00032 /// set. A reference to an FdoILongTransactionSetReader is returned from the 00033 /// GetLongTransactionsInSet command. The initial position of the 00034 /// FdoILongTransactionSetReader is prior to the first item. Thus, you must 00035 /// call ReadNext to begin accessing any data. 00036 class FdoILongTransactionSetReader : public FdoIDisposable 00037 { 00038 public: 00039 /// \brief 00040 /// Gets the name of the long transaction in the selection set currently 00041 /// being read. 00042 /// 00043 /// \return 00044 /// Returns the long transaction name 00045 /// 00046 FDO_API virtual FdoString* GetLongTransactionName() = 0; 00047 00048 /// \brief 00049 /// Gets the owner of the long transaction in the selection set currently 00050 /// being read. 00051 /// 00052 /// \return 00053 /// Returns the owner of the long transaction 00054 /// 00055 FDO_API virtual FdoString* GetOwner() = 0; 00056 00057 /// \brief 00058 /// Advances the reader to the next item. The default position of the 00059 /// reader is prior to the first item. Thus, you must call ReadNext 00060 /// to begin accessing any data. 00061 /// 00062 /// \return 00063 /// Returns true if there is a next item. 00064 /// 00065 FDO_API virtual bool ReadNext() = 0; 00066 00067 /// \brief 00068 /// Closes the FdoILongTransactionSetReader object, freeing any resources 00069 /// it may be holding. 00070 /// 00071 /// \return 00072 /// Returns nothing 00073 /// 00074 FDO_API virtual void Close() = 0; 00075 }; 00076 #endif 00077 00078
| Comments or suggestions? Send us feedback. |