CATPLMIntegrationAccess CATAdpLockInformation
Usage: you must use this class as is. You should never derive it.
public class CATAdpLockInformation
Class giving access to a set of informations resulting from a lock analysis.
Role: provide a set of informations about a component resulting from a lock analysis in a database.
Constructor and Destructor Index
- o
~CATAdpLockInformation(void)
- Destructor.
Method Index
- o
GetIdentifier(CATIAdpPLMIdentificator*&)
- Gets the component identificator.
- o
GetLockError(CATError*&)
- Gets the error which prevents from analyzing the component.
- o
GetLockState(LockState&)
- Gets a lock state.
- o
GetLockUser(CATUnicodeString&)
- Gets a lock user.
Enumerated Type Index
- o
LockState
- Description of the available lock states for a component.
Constructor and Destructor
o ~CATAdpLockInformation
| public virtual ~CATAdpLockInformation( | | ) |
-
Destructor.
Methods
o GetIdentifier
| public virtual GetIdentifier( | | oIdentifier) |
-
Gets the component identificator.
Role: Gets the
enabling to identify a component.
- Parameters:
-
- oIdentifier
- [out, CATBaseUnknown#Release] The retrieved component identificator.
- Returns:
-
S_OK if the related identifier could be retrieved.E_FAIL otherwise.
o GetLockError
| public virtual GetLockError( | | oLockAnalysisError) |
-
Gets the error which prevents from analyzing the component.
Role: Gets an error if the component could not be analyzed through the
entry point. If an error is available,
should return LockAnalyzeFailure value.
- Parameters:
-
- oLockAnalysisError[out,
- CATBaseUnknown#Release] The lock error if the analysis could not be done on the component.
- Returns:
-
S_OK if a lock error is available.E_FAIL otherwise.
o GetLockState
| public virtual GetLockState( | | oLockState) |
-
Gets a lock state.
Role: Gets a lock state corresponding to the state of the component in the database.
- Parameters:
-
- oLockState[out]
- The lock state of the component. In case of LockAnalyzeFailure, an error can be obtained through
.
- Returns:
-
S_OK if the lock state could be retrieved.E_FAIL otherwise.
o GetLockUser
| public virtual GetLockUser( | | oLockUser) |
-
Gets a lock user.
Role: Gets the user who is locking the component if the component is locked.
- Parameters:
-
- oLockUser[out]
- The lock user.
- Returns:
-
S_OK if the lock user could be retrieved.E_FAIL otherwise.
Enumerated Types
o LockState
-
enum LockState {
NotLocked,
LockedByConnectedUser,
LockedByAnotherUser,
LockAnalyzeFailure
}
Description of the available lock states for a component.
-
NotLocked - The component is not locked.
-
LockedByConnectedUser - The component is locked by the user performing the query.
-
LockedByAnotherUser - The component is locked by another user than the one performing the query.
-
LockAnalyzeFailure - The lock analysis failed on the component. The error can be obtained through
.
This object is included in the file: CATAdpLockInformation.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.