All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATIVpmObjectLock
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIVpmObjectLock
Usage: you can freely reimplement this interface.
interface CATIVpmObjectLock
This class is an interface on VPMObject to manage Locks
role: This class provides for Lock management on VPMObject
Method Index
- o
GetLockOwner(CATUnicodeString&)
- Get owner of the object.
- o
IsLocked()
- Ask an object if it locked.
- o
OverRideLock()
- Override lock of an object.
- o
SetLock()
- Lock an object.
- o
UnsetLock()
- Unlock an object.
Methods
o GetLockOwner
-
Get owner of the object.
- Parameters:
-
- oOwner
- The name of the owner.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- Lock Owner is valuated
- S_FALSE
- Lock Owner is not assign
- E_FAIL
- An error occured during the process
o IsLocked
public virtual HRESULT IsLocked( | )= 0 |
-
Ask an object if it locked.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is locked
- S_FALSE
- The object is not locked
- E_FAIL
- An error occured during the process
o OverRideLock
public virtual HRESULT OverRideLock( | )= 0 |
-
Override lock of an object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- OverRide Lock processing
- Warning: the overide will be available only during runtime.
- The commit process will verify all locked objects.
- E_FAIL
- An error occured during the process
o SetLock
public virtual HRESULT SetLock( | )= 0 |
-
Lock an object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is locked
- S_FALSE
- The object is already locked by another user
- E_FAIL
- An error occured during the lock process
o UnsetLock
public virtual HRESULT UnsetLock( | )= 0 |
-
Unlock an object.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object is unlocked
- E_FAIL
- An error occured during the process
This object is included in the file: CATIVpmObjectLock.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces