| FDO API Reference | Feature Data Objects |
00001 #ifndef _ILOCKOWNERSREADER_H_ 00002 #define _ILOCKOWNERSREADER_H_ 00003 // 00004 00005 // 00006 // Copyright (C) 2004-2006 Autodesk, Inc. 00007 // 00008 // This library is free software; you can redistribute it and/or 00009 // modify it under the terms of version 2.1 of the GNU Lesser 00010 // General Public License as published by the Free Software Foundation. 00011 // 00012 // This library is distributed in the hope that it will be useful, 00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00015 // Lesser General Public License for more details. 00016 // 00017 // You should have received a copy of the GNU Lesser General Public 00018 // License along with this library; if not, write to the Free Software 00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00020 // 00021 00022 #ifdef _WIN32 00023 #pragma once 00024 #endif 00025 00026 #include <FdoStd.h> 00027 00028 /// \brief 00029 /// The FdoILockOwnersReader interface provides forward-only, read-only functionality 00030 /// for identifying users. A connected user has status of lock owner even if he has 00031 /// no locks or has released his locks. 00032 /// \remarks 00033 /// A reference to an 00034 /// FdoILockOwnersReader interface is returned from the GetLockOwners command. The initial 00035 /// position of the FdoILockOwnersReader interface is prior to the first item. Thus, you 00036 /// must call ReadNext to begin accessing any data. 00037 class FdoILockOwnersReader : public FdoIDisposable 00038 { 00039 00040 public: 00041 00042 /// \brief 00043 /// Gets the name of a user. 00044 /// 00045 /// \return 00046 /// Returns the name of a user 00047 /// 00048 FDO_API virtual FdoString* GetLockOwner() = 0; 00049 00050 /// \brief 00051 /// Advances the reader to the next item. The default position of the 00052 /// reader is prior to the first item. Thus, you must call ReadNext 00053 /// to begin accessing any data. 00054 /// 00055 /// \return 00056 /// Returns true if there is a next item. 00057 /// 00058 FDO_API virtual bool ReadNext() = 0; 00059 00060 /// \brief 00061 /// Closes the FdoILockOwnersReader object, freeing any resources it may be 00062 /// holding. 00063 /// 00064 /// \return 00065 /// Returns nothing 00066 /// 00067 FDO_API virtual void Close() = 0; 00068 00069 }; 00070 #endif 00071 00072
| Comments or suggestions? Send us feedback. |