|
|
The FdoLockType enumeration defines lock types. The lock type for a locked object indicates a user's access privileges (including the user who applied the persistent lock) to an object.
The enumeration values are used with the commands FdoIAcquireLock, FdoISelect and FdoIGetLockInfo. With the command FdoIAcquireLock or FdoISelect, the specified value indicates the lock type to be used when applying a lock on an object. With the command FdoIGetLockInfo, the enumaration values are used to report lock types back to the user.
The enumeration contains some special lock types (FdoLockType_None and FdoLockType_Unsupported) that are used only when reporting lock type information. These special lock types cannot be used to specify a lock type to be applied to an object. - Parameters:
-
| FdoLockType_None | Indicates that an object is unlocked. This type cannot be used with the commands FdoIAcquireLock and FdoISelect. |
| FdoLockType_Unsupported | Indicates that an unsupported lock type has been encountered. This type cannot be used with the commands FdoIAcquireLock and FdoISelect. |
| FdoLockType_Shared | Indicates a shared lock type. The type can be used with the commands FdoIAcquireLock and FdoISelect. |
| FdoLockType_Transaction | Indicates that a transaction lock should be applied on an object. This type can be used with the commands FdoIAcquireLock and FdoISelect. |
| FdoLockType_Exclusive | Indicates that only this user can modify this object. In a long transaction situation, any user can modify the object in any other long transaction, including the root long transaction if it is not the current long transaction. |
The type can be used with the commands FdoIAcquireLock and FdoISelect.
- Parameters:
-
| FdoLockType_LongTransactionExclusive | Indicates that only this user can modify this object in the long transaction containing the object or any long transaction created as a descendent of that one. When not in a long transaction situation (for example, if only a root long transaction exists), the lock behaves like an Exclusive lock. |
The type can be used with the commands FdoIAcquireLock and FdoISelect.
- Parameters:
-
| FdoLockType_AllLongTransactionExclusive | Indicates that only this user can modify this object in this long transaction. No user, not even the user locking the object, can modify the object in any long transaction created as a descendent of the one containing the object being locked. When not in a long transaction situation (for example, if only a root long transaction exists), the lock behaves like an Exclusive lock. |
This type can be used with the commands FdoIAcquireLock and FdoISelect. - Enumerator:
-
| FdoLockType_None |
|
| FdoLockType_Shared |
|
| FdoLockType_Exclusive |
|
| FdoLockType_Transaction |
|
| FdoLockType_Unsupported |
|
| FdoLockType_AllLongTransactionExclusive |
|
| FdoLockType_LongTransactionExclusive |
|
Definition at line 86 of file LockType.h. |