CATPLMIntegrationAccess CATAdpLockServices
Usage: you must use this class as is. You should never derive it.
public class CATAdpLockServices
Class to manage Lock services in CATIA session.
Role: Provides all basic functions to lock or unlock data.
- To process a lock operation, you will need a PLM identificator, interface pointer. You can use
to retrieve it, or use the
method if your component is already in session.
Method Index
- o
IsLocked(CATLISTP(CATIAdpPLMIdentificator)&,CATLISTP(CATAdpLockInformation)&,CATIAdpPLMErrorReviewer*)
- Gets the lock status of components.
- o
Lock(CATListPtrCATIAdpPLMIdentificator&,CATIAdpPLMErrorReviewer*)
- Performs a lock.
- o
Unlock(CATListPtrCATIAdpPLMIdentificator&,CATIAdpPLMErrorReviewer*)
- Performs a unlock.
Methods
o IsLocked
| public static IsLocked( | const | iComponents, |
| | oLockInformations, |
| | iopErrorReviewer | = NULL ) |
-
Gets the lock status of components.
Role:Queries the database to retrieve the lock status of a set of components.
- Parameters:
-
- iComponents
- [in] The identifiers of components which lock status is required.
- oLockInformations
- [out] Returned list with all provided components given access to its lock information through the
contract.
- The list is emptied by the beginning of the method.
- You must delete the elements of the list when useless.
- Objects are identified through
by using the
method.
- iopErrorReviewer
- [inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.
- Returns:
-
S_OK if the lock informations could be retrieved in the database.E_INVALIDARG if an invalid set of components was provided (empty set).E_FAIL if a fatal error occured during the operation. The blocking error can be accessed through
method.
o Lock
| public static Lock( | | iToBeProceed, |
| | iopErrorReviewer | = NULL ) |
-
Performs a lock.
Role:This method locks a component. This method is not recursive.
- Parameters:
-
- iToBeProceed
- [in] The list of PLM identificator to lock.
- iopErrorReviewer
- [inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.
- Returns:
-
- S_OK The components have all been locked.
- S_FALSE At least one of the components holds a warning
- E_FAIL A fatal error happened during the lock operation. Nothing was done during the operation.
o Unlock
| public static Unlock( | | iToBeProceed, |
| | iopErrorReviewer | = NULL ) |
-
Performs a unlock.
Role:This method unlocks a list of components. This method is not recursive.
- Parameters:
-
- iToBeProceed
- [in] The list of PLM identificator to unlock.
- iopErrorReviewer
- [inout] The ErrorReviewer dedicated to store and handle all PLM Errors raised during the execution of this service.
- Returns:
-
- S_OK The components have all been unlocked.
- S_FALSE At least one of the components holds a warning
- E_FAIL A fatal error happened during the unlock operation. Nothing was done during the operation.
This object is included in the file: CATAdpLockServices.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.