FDO .NET API Reference Feature Data Objects

mgILongTransactionSetReader.h

Go to the documentation of this file.
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::ILongTransactionSetReader
00025 /// \brief
00026 /// The ILongTransactionSetReader interface provides forward only, read-only
00027 /// functionality for enumerating the versions in the long transaction selection
00028 /// set.  A reference to an ILongTransactionSetReader is returned from the
00029 /// GetLongTransactionsInSet command. The initial position of the
00030 /// ILongTransactionSetReader is prior to the first item. Thus, you must
00031 /// call ReadNext to begin accessing any data.
00032 public __gc __interface ILongTransactionSetReader : public System::IDisposable
00033 {
00034 public:
00035     /// \brief
00036     /// Gets the name of the long transaction in the selection set currently
00037     /// being read.
00038     /// 
00039     /// \return
00040     /// Returns the long transaction name
00041     /// 
00042     System::String* GetLongTransactionName();
00043 
00044     /// \brief
00045     /// Gets the owner of the long transaction in the selection set currently
00046     /// being read.
00047     /// 
00048     /// \return
00049     /// Returns the owner of the long transaction
00050     /// 
00051     System::String* GetOwner();
00052 
00053     /// \brief
00054     /// Advances the reader to the next item. The default position of the
00055     /// reader is prior to the first item. Thus, you must call ReadNext
00056     /// to begin accessing any data.
00057     /// 
00058     /// \return
00059     /// Returns true if there is a next item.
00060     /// 
00061     System::Boolean ReadNext();
00062 
00063     /// \brief
00064     /// Closes the ILongTransactionSetReader object, freeing any resources
00065     /// it may be holding.
00066     /// 
00067     /// \return
00068     /// Returns nothing
00069     /// 
00070     System::Void Close();
00071 };
00072 
00073 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00074 
00075 

Comments or suggestions? Send us feedback.