All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDACommand

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

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


interface CATIAVPMVDACommand

Base interface to a server command.
Role: Every interface of a server command derives from this base interface. It provides the basic functionnalities shared by all other commands: a flag to know if the command can be executed or not, the calls to the user exit, and the call to the execution which is specific to each command.
This a base interface designed for internal inheritance architecture, so it won't work if you reimplement it directly.


Please note :
- Do not reuse a command,
- A command that has been executed can only be consulted for information on the parameters used, and then released.

The correct methodology is :
- Create the command
- Execute the command
- Possibly consult the command
- Release the command
- Create another command if necessary to repeat the process.


Method Index


o Exec()
Starts the execution of the method.
o Test()
Test() method checks for security, lock and lifecyle status.
o get_ExecFlag(CATBoolean&)
Retrieves the execution flag to know if the command can be executed.
o put_ExecFlag(CATBoolean)
Sets the execution flag to know if the command can be executed.

Methods


o Exec
public virtual HRESULT __stdcall Exec()=0
Starts the execution of the method. This method checks if the command can be executed, and if this is the case, calls the user exit with CATIAVPMVDACommandExtension.Prepare method, then executes the command, and ends with the user exit CATIAVPMVDACommandExtension.Cleanup() method.
Returns:
S_OK in case of success, E_FAIL in case of error.
o Test
public virtual HRESULT __stdcall Test()=0
Test() method checks for security, lock and lifecyle status.
Returns:
S_OK, if all the check is complete and successful
Returns:
E_FAIL, if any of the checks is not successful
o get_ExecFlag
public virtual HRESULT __stdcall get_ExecFlag(CATBoolean& oThisCommandIsExecutable)= 0
Retrieves the execution flag to know if the command can be executed.
Parameters:
oThisCommandIsExecutable
The execution flag.
Returns:
Always S_OK.
o put_ExecFlag
public virtual HRESULT __stdcall put_ExecFlag(CATBoolean iThisCommandIsExecutable)= 0
Sets the execution flag to know if the command can be executed. You should not need to call this method.
To prevent a command from being executed, return an error code in the CATIAVPMVDACommandExtension.Prepare method.
Parameters:
iThisCommandIsExecutable
The execution flag.
Returns:
Always S_OK.

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

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