FDO .NET API Reference Feature Data Objects

mgIGetLongTransactions.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 #include "FDO\Commands\mgICommand.h"
00022 
00023 BEGIN_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00024 public __gc __interface ILongTransactionReader;
00025 
00026 /// \ingroup (OSGeoFDOCommandsLongTransaction)
00027 /// \interface OSGeo::FDO::Commands::LongTransaction::IGetLongTransactions
00028 /// \brief
00029 /// The IGetLongTransactions interface defines the GetLongTransactions
00030 /// command. It allows a user to retrieve long transaction information for all or
00031 /// a specific long transaction. The command returns a ILongTransactionReader
00032 /// object enumerating the identified long transactions.
00033 public __gc __interface IGetLongTransactions : public NAMESPACE_OSGEO_FDO_COMMANDS::ICommand
00034 {
00035 public:
00036     /// \brief
00037     /// Sets the name of the long transaction for which information
00038     /// should be retrieved. The function can also be used to nullify the
00039     /// property by using a NULL pointer as the function's parameter. If the
00040     /// the property is not set, the function returns information for all
00041     /// available long transactions.
00042     /// 
00043     /// \return
00044     /// Returns nothing
00045     /// 
00046     __property System::Void set_Name(System::String* value);
00047 
00048     /// \brief
00049     /// Gets the currently set name of the long transaction for which
00050     /// the long transaction information should be retrieved. If the property
00051     /// is not set, the function returns a NULL pointer.
00052     /// 
00053     /// \return
00054     /// Returns a long transaction name.
00055     /// 
00056     __property System::String* get_Name();
00057 
00058     /// \brief
00059     /// Executes the GetLongTransactions command returning a reference to an
00060     /// ILongTransactionReader.
00061     /// 
00062     /// \return
00063     /// Returns a long transaction reader
00064     /// 
00065     NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION::ILongTransactionReader* Execute();
00066 };
00067 
00068 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00069 
00070 

Comments or suggestions? Send us feedback.