FDO .NET API Reference Feature Data Objects

mgILockOwnersReader.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_LOCKING
00022 
00023 /// \ingroup (OSGeoFDOCommandsLocking)
00024 /// \interface OSGeo::FDO::Commands::Locking::ILockOwnersReader
00025 /// \brief
00026 /// The ILockOwnersReader interface provides forward-only, read-only functionality
00027 /// for identifying users. A connected user has status of lock owner even if he has
00028 /// no locks or has released his locks.
00029 /// \remarks
00030 /// A reference to an
00031 /// ILockOwnersReader interface is returned from the GetLockOwners command. The initial
00032 /// position of the ILockOwnersReader interface is prior to the first item. Thus, you
00033 /// must call ReadNext to begin accessing any data.
00034 public __gc __interface ILockOwnersReader : public System::IDisposable
00035 {
00036 public:
00037     /// \brief
00038     /// Gets the name of a user.
00039     /// 
00040     /// \return
00041     /// Returns the name of a user
00042     /// 
00043     System::String* GetLockOwner();
00044 
00045     /// \brief
00046     /// Advances the reader to the next item. The default position of the 
00047     /// reader is prior to the first item. Thus, you must call ReadNext
00048     /// to begin accessing any data.
00049     /// 
00050     /// \return
00051     /// Returns true if there is a next item.
00052     /// 
00053     System::Boolean ReadNext();
00054 
00055     /// \brief
00056     /// Closes the ILockOwnersReader object, freeing any resources it may be
00057     /// holding.
00058     /// 
00059     /// \return
00060     /// Returns nothing
00061     /// 
00062     System::Void Close();
00063 };
00064 
00065 END_NAMESPACE_OSGEO_FDO_COMMANDS_LOCKING
00066 
00067 

Comments or suggestions? Send us feedback.