All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDACommandExtension

System.IUnknown
  |
  +---CATIAVPMVDACommandExtension
 

Usage: you can freely reimplement this interface.


interface CATIAVPMVDACommandExtension

Interface to customize server commands.
Role: You should reimplement this interface to code some command-specific code around a given command. Every command checks for the existence of an implementation of this interface, and calls the two methods just before and just after the execution of the base command. The name of the class implementing this interface must be related to the command to customize.
An example is given in the framework CAAVPMDesktopObjects.edu.


Method Index


o Cleanup()
Cleans up when the command is completed.
o Prepare()
Prepares the command execution.

Methods


o Cleanup
public virtual HRESULT __stdcall Cleanup()=0
Cleans up when the command is completed. You should implement it.
Returns:
S_OK in case of success.
E_FAIL in case of error, the code following the execution of the command will not be executed and the error will be propagated.
o Prepare
public virtual HRESULT __stdcall Prepare()=0
Prepares the command execution. You should implement it.
Returns:
S_OK in case of success, the command is then executed.
E_FAIL in case of error, the command will not be executed.

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

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