Table of Contents
Table of Contentsclass PtObjStateMaxLockPtObjStateMaxLock is a class that you can use to get information about the strongest lock that has been applied to an object. First, create a PtObjStateMaxLock, then pass it as a parameter to the object using PtObject::GetObjectInfo(). Once you have done this, the PtObjStateMaxLock contains information on the strongest lock that is active for the object.
PtObjStateMaxLock: class summary| Files to include | Class declaration | Base class |
| poet.hxx | ptinfo.hxx | PtObjState |
| constructor | PtObjStateMaxLock(); |
| destructor | virtual ~PtObjStateMaxLock(); |
| GetClientId | inline const PtClientId& GetClientId() const; |
| GetClientName | inline const PtString& GetClientName() const; |
| GetLockMode | inline PtLockMode GetLockMode() const; |
| GetLockType | inline PtLockType GetLockType() const; |
| GetUserId | inline short GetUserId() const; |
| GetUserName | inline const PtString& GetUserName() const; |
PtObjStateMaxLock::PtObjStateMaxLock() - PtObjStateMaxLock::PtObjStateMaxLock()
- virtual PtObjStateMaxLock::~PtObjStateMaxLock()
- inline const PtClientId& PtObjStateMaxLock::GetClientId() const
Returns the client Id of the process which owns the lock. This contains information about the client.
PtObjStateMaxLock::GetClientName() - inline const PtString& PtObjStateMaxLock::GetClientName() const
Returns the client name of the process which owns the lock. This is the same name which is displayed by the POET Administrator's Workbench when you list the processes. These names are set as a parameter to InitPOET(), or using configuration files on the client.
PtObjStateMaxLock::GetLockMode() - inline PtLockMode PtObjStateMaxLock::GetLockMode() const
Returns the lock mode for the strongest lock that is active for the object.
PtObjStateMaxLock::GetLockType() - inline PtLockType PtObjStateMaxLock::GetLockType() const
Returns the lock type for the maximum lock. Lock types may be either of the following:
| PtLK_NONPERS | The lock is not persistent. |
| PtLK_PERS | The lock is persistent. |
Persistent locks are used internally for CheckIn/CheckOut.
PtObjStateMaxLock::GetUserId() - inline const PtString& PtObjStateMaxLock::GetUserId() const
Returns the user Id of the process which owns the lock. This is the same Id which is displayed by the POET Administrator's Workbench when you list the processes.
Copyright (c) 1996 POET Software, Inc. All rights reserved. Reproduction in whole or in part in any form or medium without the express permission of POET Software, Inc. is prohibited.