FDO .NET API Reference Feature Data Objects

mgILongTransactionPrivilegeReader.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::ILongTransactionPrivilegeReader
00025 /// \brief
00026 /// The ILongTransactionPrivilegeReader interface provides forward only,
00027 /// read-only functionality for enumerating long transaction privileges.
00028 /// A reference to an FdoILongTransactionPrivilegeReader is returned from
00029 /// the GetLongTransactionPrivileges command. The initial position of
00030 /// the ILongTransactionPrivilegeReader is prior to the first item.
00031 /// Thus, you must call ReadNext to begin accessing any data.
00032 public __gc __interface ILongTransactionPrivilegeReader : public System::IDisposable
00033 {
00034 public:
00035     /// \brief
00036     /// Gets the name of the user currently being read.
00037     /// 
00038     /// \return
00039     /// Returns the user name
00040     /// 
00041     System::String* GetUsername();
00042 
00043     /// \brief
00044     /// Gets the privileges granted to the user currently being read. The
00045     /// returned value may be any combination of the values from the
00046     /// LongTransactionPrivileges enumeration combined via a bit-wise or
00047     /// operation.
00048     /// 
00049     /// \return
00050     /// Returns the privileges as a bit masked value based on LongTransactionPrivileges enumeration
00051     /// 
00052     System::Int32 GetPrivileges();
00053 
00054     /// \brief
00055     /// Advances the reader to the next item. The default position of the
00056     /// reader is prior to the first item. Therefore you must call ReadNext
00057     /// to begin accessing any data.
00058     /// 
00059     /// \return
00060     /// Returns true if there is a next item
00061     /// 
00062     System::Boolean ReadNext();
00063 
00064     /// \brief
00065     /// Closes the ILongTransactionPrivilegesReader object, freeing any
00066     /// resources it may be holding.
00067     /// 
00068     /// \return
00069     /// Returns nothing
00070     /// 
00071     System::Void Close();
00072 };
00073 
00074 END_NAMESPACE_OSGEO_FDO_COMMANDS_LONGTRANSACTION
00075 
00076 

Comments or suggestions? Send us feedback.