FDO API Reference | Feature Data Objects |
00001 #ifndef _LOCKTYPE_H_ 00002 #define _LOCKTYPE_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 /// \brief 00027 /// The FdoLockType enumeration defines lock types. The lock type for 00028 /// a locked object indicates a user's access privileges (including the user 00029 /// who applied the persistent lock) to an object. 00030 /// <p> 00031 /// The enumeration values are used with the commands FdoIAcquireLock, FdoISelect 00032 /// and FdoIGetLockInfo. With the command FdoIAcquireLock or FdoISelect, the 00033 /// specified value indicates the lock type to be used when applying a lock on 00034 /// an object. With the command FdoIGetLockInfo, the enumaration values are used 00035 /// to report lock types back to the user. 00036 /// <p> 00037 /// The enumeration contains some special lock types (FdoLockType_None and FdoLockType_Unsupported) 00038 /// that are used only when reporting lock type information. 00039 /// These special lock types cannot be used to specify a lock type to be applied 00040 /// to an object. 00041 /// <param name="FdoLockType_None"> 00042 /// Indicates that an object is unlocked. 00043 /// This type cannot be used with the commands FdoIAcquireLock and FdoISelect. 00044 /// </param> 00045 /// <param name="FdoLockType_Unsupported"> 00046 /// Indicates that an unsupported lock 00047 /// type has been encountered. This type cannot be used with the commands 00048 /// FdoIAcquireLock and FdoISelect. 00049 /// </param> 00050 /// <param name="FdoLockType_Shared"> 00051 /// Indicates a shared lock type. The type can 00052 /// be used with the commands FdoIAcquireLock and FdoISelect. 00053 /// </param> 00054 /// <param name="FdoLockType_Transaction"> 00055 /// Indicates that a transaction lock 00056 /// should be applied on an object. This type can be used with the commands 00057 /// FdoIAcquireLock and FdoISelect. 00058 /// </param> 00059 /// <param name="FdoLockType_Exclusive"> 00060 /// Indicates that only this user can modify 00061 /// this object. In a long transaction situation, any user can modify the object in any 00062 /// other long transaction, including the root long transaction if it is not the current 00063 /// long transaction. 00064 /// <P> 00065 /// The type can be used with the commands FdoIAcquireLock and FdoISelect. 00066 /// </param> 00067 /// <param name="FdoLockType_LongTransactionExclusive"> 00068 /// Indicates that only this user can 00069 /// modify this object in the long transaction containing the object or any long 00070 /// transaction created as a descendent of that one. When not in a long transaction 00071 /// situation (for example, if only a root long transaction exists), the lock behaves 00072 /// like an Exclusive lock. 00073 /// <P> 00074 /// The type can be used with the commands FdoIAcquireLock and FdoISelect. 00075 /// </param> 00076 /// <param name="FdoLockType_AllLongTransactionExclusive"> 00077 /// Indicates that only this user can 00078 /// modify this object in this long transaction. No user, not even the user locking the object, 00079 /// can modify the object in any long transaction created as a descendent of the one 00080 /// containing the object being locked. When not in a long transaction situation (for example, 00081 /// if only a root long transaction exists), the lock behaves like an Exclusive lock. 00082 /// <P> 00083 /// This type can be used with the commands FdoIAcquireLock and FdoISelect. 00084 /// </param> 00085 00086 enum FdoLockType 00087 { 00088 00089 FdoLockType_None, 00090 FdoLockType_Shared, 00091 FdoLockType_Exclusive, 00092 FdoLockType_Transaction, 00093 FdoLockType_Unsupported, 00094 FdoLockType_AllLongTransactionExclusive, 00095 FdoLockType_LongTransactionExclusive 00096 00097 }; 00098 #endif 00099 00100
Comments or suggestions? Send us feedback. |