| FDO API Reference | Feature Data Objects |
00001 #ifndef _ILONGTRANSACTIONCHECKPOINTREADER_H_ 00002 #define _ILONGTRANSACTIONCHECKPOINTREADER_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 00028 /// \brief 00029 /// The FdoILongTransactionCheckpointReader interface provides forward only, 00030 /// read-only functionality for enumerating long transaction checkpoints. 00031 /// A reference to an FdoILongTransactionCheckpointReader is returned from 00032 /// the GetLongTransactionCheckpoints command. The initial position of 00033 /// the FdoILongTransactionCheckpointReader is prior to the first item. 00034 /// Thus, you must call ReadNext to begin accessing any data. 00035 class FdoILongTransactionCheckpointReader : public FdoIDisposable 00036 { 00037 public: 00038 /// \brief 00039 /// Gets the name of the checkpoint currently being read. 00040 /// 00041 /// \return 00042 /// Returns the checkpoint name 00043 /// 00044 FDO_API virtual FdoString* GetCheckpointName() = 0; 00045 00046 /// \brief 00047 /// Gets the description of the checkpoint currently being read. 00048 /// 00049 /// \return 00050 /// Returns the checkpoint description 00051 /// 00052 FDO_API virtual FdoString* GetCheckpointDescription() = 0; 00053 00054 /// \brief 00055 /// Gets the creation date of the checkpoint currently being read. 00056 /// 00057 /// \return 00058 /// Returns the creation date 00059 /// 00060 FDO_API virtual FdoDateTime GetCreationDate() = 0; 00061 00062 /// \brief 00063 /// Returns true if the checkpoint currently being read is the active 00064 /// checkpoint. 00065 /// 00066 /// \return 00067 /// Returns true if the checkpoint is active. 00068 /// 00069 FDO_API virtual bool IsActive() = 0; 00070 00071 /// \brief 00072 /// Advances the reader to the next item. The default position of the 00073 /// reader is prior to the first item. Thus, you must call ReadNext 00074 /// to begin accessing any data. 00075 /// 00076 /// \return 00077 /// Returns true if there is a next item. 00078 /// 00079 FDO_API virtual bool ReadNext() = 0; 00080 00081 /// \brief 00082 /// Closes the FdoILongTransactionCheckpointReader object, freeing any 00083 /// resources it may be holding. 00084 /// 00085 /// \return 00086 /// Returns nothing 00087 /// 00088 FDO_API virtual void Close() = 0; 00089 }; 00090 #endif 00091 00092
| Comments or suggestions? Send us feedback. |