FDO .NET API Reference | Feature Data Objects |
00001 /* 00002 * Copyright (C) 2004-2006 Autodesk, Inc. 00003 * 00004 * This library is free software; you can redistribute it and/or 00005 * modify it under the terms of version 2.1 of the GNU Lesser 00006 * General Public License as published by the Free Software Foundation. 00007 * 00008 * This library is distributed in the hope that it will be useful, 00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00011 * Lesser General Public License for more details. 00012 * 00013 * You should have received a copy of the GNU Lesser General Public 00014 * License along with this library; if not, write to the Free Software 00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00016 * 00017 */ 00018 00019 #pragma once 00020 00021 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION 00022 00023 /// \ingroup (OSGeoFDOCommandsLongTransaction) 00024 /// \interface OSGeo::FDO::Commands::LongTransaction::ILongTransactionCheckpointReader 00025 /// \brief 00026 /// The ILongTransactionCheckpointReader interface provides forward only, 00027 /// read-only functionality for enumerating long transaction checkpoints. 00028 /// A reference to an ILongTransactionCheckpointReader is returned from 00029 /// the GetLongTransactionCheckpoints command. The initial position of 00030 /// the ILongTransactionCheckpointReader is prior to the first item. 00031 /// Thus, you must call ReadNext to begin accessing any data. 00032 public __gc __interface ILongTransactionCheckpointReader : public System::IDisposable 00033 { 00034 public: 00035 /// \brief 00036 /// Gets the name of the checkpoint currently being read. 00037 /// 00038 /// \return 00039 /// Returns the checkpoint name 00040 /// 00041 System::String* GetCheckpointName(); 00042 00043 /// \brief 00044 /// Gets the description of the checkpoint currently being read. 00045 /// 00046 /// \return 00047 /// Returns the checkpoint description 00048 /// 00049 System::String* GetCheckpointDescription(); 00050 00051 /// \brief 00052 /// Gets the creation date of the checkpoint currently being read. 00053 /// 00054 /// \return 00055 /// Returns the creation date 00056 /// 00057 System::DateTime GetCreationDate(); 00058 00059 /// \brief 00060 /// Returns true if the checkpoint currently being read is the active 00061 /// checkpoint. 00062 /// 00063 /// \return 00064 /// Returns true if the checkpoint is active. 00065 /// 00066 System::Boolean IsActive(); 00067 00068 /// \brief 00069 /// Advances the reader to the next item. The default position of the 00070 /// reader is prior to the first item. Thus, you must call ReadNext 00071 /// to begin accessing any data. 00072 /// 00073 /// \return 00074 /// Returns true if there is a next item. 00075 /// 00076 System::Boolean ReadNext(); 00077 00078 /// \brief 00079 /// Closes the ILongTransactionCheckpointReader object, freeing any 00080 /// resources it may be holding. 00081 /// 00082 /// \return 00083 /// Returns nothing 00084 /// 00085 System::Void Close(); 00086 }; 00087 00088 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION 00089 00090
Comments or suggestions? Send us feedback. |