All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDALock

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDALock
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAVPMVDALock

This interface locks an object.
Role : This interface locks a business object. Some objects like the Part Instance can have a lock on the instance as well as on the reference, so there is a flag to determine which part will have the lock, or both.


Method Index


o get_BObject(ENOVIABusinessObject*&)
This method gives the current object to be locked.
o get_lockOwner(CATUnicodeString&)
This method gives the owner of the lock of the current object, either after this lock command has succeeded, either someone else has locked the object and this lock command can not succeed.
o get_referenceAlso(boolean&)
This method gives the flag to know if the reference must be locked also.
o put_BObject(ENOVIABusinessObject*)
This method sets the Business Object to lock.
o put_referenceAlso(boolean)
In the case of a Part Instance, the reference can be locked at the same time as the instance; in this case this flag must be true.

Methods


o get_BObject
public virtual HRESULT __stdcall get_BObject(ENOVIABusinessObject*& object)=0
This method gives the current object to be locked. It is designed for the user-exit for the customer, and should not be used in another context.
Parameters:
object
The object to lock.
Returns:
Always S_OK.
o get_lockOwner
public virtual HRESULT __stdcall get_lockOwner(CATUnicodeString& owner)=0
This method gives the owner of the lock of the current object, either after this lock command has succeeded, either someone else has locked the object and this lock command can not succeed.
Parameters:
owner
The owner of the lock.
Returns:
Always S_OK.
o get_referenceAlso
public virtual HRESULT __stdcall get_referenceAlso(boolean& refAlso)=0
This method gives the flag to know if the reference must be locked also. It is designe for the user-exit for the customer, and should not be used in another context.
Parameters:
refAlso
The flag.
Returns:
Always S_OK.
o put_BObject
public virtual HRESULT __stdcall put_BObject(ENOVIABusinessObject* object)=0
This method sets the Business Object to lock.
Parameters:
object
The object to lock.
Returns:
S_OK if the object can be locked in theory, S_FALSE if not.
o put_referenceAlso
public virtual HRESULT __stdcall put_referenceAlso(boolean refAlso)=0
In the case of a Part Instance, the reference can be locked at the same time as the instance; in this case this flag must be true.
Parameters:
refAlso
Sets whether the reference is locked as well as the instance (true) of a Part Instance, or not (flag set to false).
Returns:
Always S_OK.

This object is included in the file: CATIAVPMVDALock.h
If needed, your Imakefile.mk should include the module: VDO0Commands

Copyright © 2003, Dassault Systèmes. All rights reserved.