All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDAUnlock

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

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


interface CATIAVPMVDAUnlock

This interface unlocks an object.
Role : This interface unlocks 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 unlocked.
o get_referenceOnly(boolean&)
Gets the option set by the caller to unlock only the reference or both the reference and the instance in case of a PartInstance.
o put_BObject(ENOVIABusinessObject*)
This method sets the Business Object to unlock.
o put_referenceOnly(boolean)
In the case of a PartInstance, the caller can ask to unlock only the reference and leave the instance locked (parameter set to true), or unlock both the reference and the instance (parameter set to false).
o put_usageOnly(boolean)
In the case of a PartInstance, the caller can ask to unlock only the Usage and leave the reference locked (parameter set to true), or unlock both the reference and the instance (parameter set to false) if the object is a PartInstance and refOnly flag is false.

Methods


o get_BObject
public virtual HRESULT __stdcall get_BObject(ENOVIABusinessObject*& object)= 0
This method gives the current object to be unlocked. It is designed for the user-exit for the customer, and should not be used in another context.
Parameters:
object
The object to unlock.
Returns:
Always S_OK.
o get_referenceOnly
public virtual HRESULT __stdcall get_referenceOnly(boolean& refAlso)= 0
Gets the option set by the caller to unlock only the reference or both the reference and the instance in case of a PartInstance.
Parameters:
refAlso
Flag to unlock only the reference (true) or the reference and the instance (false) if the object is a PartInstance.
Returns:
Always S_OK.
o put_BObject
public virtual HRESULT __stdcall put_BObject(ENOVIABusinessObject* object)= 0
This method sets the Business Object to unlock.
Parameters:
object
The Business Object to unlock.
Returns:
S_OK if the object can be unlocked in theory S_FALSE if not.
o put_referenceOnly
public virtual HRESULT __stdcall put_referenceOnly(boolean refOnly)= 0
In the case of a PartInstance, the caller can ask to unlock only the reference and leave the instance locked (parameter set to true), or unlock both the reference and the instance (parameter set to false).
Parameters:
refOnly
Flag to unlock only the reference (true) or the reference and the instance (false) if the object is a PartInstance.
Returns:
Always S_OK.
o put_usageOnly
public virtual HRESULT __stdcall put_usageOnly(boolean usageOnly)= 0
In the case of a PartInstance, the caller can ask to unlock only the Usage and leave the reference locked (parameter set to true), or unlock both the reference and the instance (parameter set to false) if the object is a PartInstance and refOnly flag is false.
Parameters:
UsageOnly
Flag to unlock only the Usage (true) or the reference and the instance (false) if the object is a PartInstance and refOnly flag is false.
Returns:
Always S_OK.

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

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