| FDO API Reference | Feature Data Objects |
00001 #ifndef _ILONGTRANSACTIONPRIVILEGEREADER_H_ 00002 #define _ILONGTRANSACTIONPRIVILEGEREADER_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 FdoILongTransactionPrivilegeReader interface provides forward only, 00030 /// read-only functionality for enumerating long transaction privileges. 00031 /// A reference to an FdoILongTransactionPrivilegeReader is returned from 00032 /// the GetLongTransactionPrivileges command. The initial position of 00033 /// the FdoILongTransactionPrivilegeReader is prior to the first item. 00034 /// Thus, you must call ReadNext to begin accessing any data. 00035 class FdoILongTransactionPrivilegeReader : public FdoIDisposable 00036 { 00037 public: 00038 /// \brief 00039 /// Gets the name of the user currently being read. 00040 /// 00041 /// \return 00042 /// Returns the user name 00043 /// 00044 FDO_API virtual FdoString* GetUserName() = 0; 00045 00046 /// \brief 00047 /// Gets the privileges granted to the user currently being read. The 00048 /// returned value may be any combination of the values from the 00049 /// FdoLongTransactionPrivileges enumeration combined via a bit-wise or 00050 /// operation. 00051 /// 00052 /// \return 00053 /// Returns the privileges as a bit masked value based on FdoLongTransactionPrivileges enumeration 00054 /// 00055 FDO_API virtual FdoInt32 GetPrivileges() = 0; 00056 00057 /// \brief 00058 /// Advances the reader to the next item. The default position of the 00059 /// reader is prior to the first item. Therefore you must call ReadNext 00060 /// to begin accessing any data. 00061 /// 00062 /// \return 00063 /// Returns true if there is a next item 00064 /// 00065 FDO_API virtual bool ReadNext() = 0; 00066 00067 /// \brief 00068 /// Closes the FdoILongTransactionPrivilegesReader object, freeing any 00069 /// resources it may be holding. 00070 /// 00071 /// \return 00072 /// Returns nothing 00073 /// 00074 FDO_API virtual void Close() = 0; 00075 }; 00076 #endif 00077 00078
| Comments or suggestions? Send us feedback. |