All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface VPMIWflApplicationHandler

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---VPMIWflApplicationHandler
 

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


interface VPMIWflApplicationHandler

This interface allows to handle WFL applications and access the parameters which are passed in/out.


Method Index


o GetParameter(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown*&)
Retrieve a parameter value from the htable.
o GetParameter(CATUnicodeString&,CATUnicodeString&,CATUnicodeString*&)
Retrieve a parameter value from the htable.
o PutParameter(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown*)
Put a parameter value in the htable.
o PutParameter(CATUnicodeString&,CATUnicodeString&,CATUnicodeString*)
Put a parameter value in the htable.
o RemoveParameter(CATUnicodeString&,CATUnicodeString&)
Remove a parameter of whatever type (object or primitive type) from the htable.

Methods


o GetParameter
public virtual HRESULT GetParameter( const CATUnicodeString& iProcessName,
const CATUnicodeString& iParamName,
CATBaseUnknown*& oObj) = 0
Retrieve a parameter value from the htable. The value must be an object.
Legal values: S_OK If the operation succeeds E_FAIL The operation fails
Parameters:
iProcessName
iParamName
oObj
The object retrieved from the htable if any.
o GetParameter
public virtual HRESULT GetParameter( const CATUnicodeString& iProcessName,
const CATUnicodeString& iParamName,
CATUnicodeString*& oValue) = 0
Retrieve a parameter value from the htable. The value must be of a primitive type (string).
Legal values: S_OK If the operation succeeds E_FAIL The operation fails
Parameters:
iProcessName
iParamName
oValue
The value retrieved from the htable if any.
o PutParameter
public virtual HRESULT PutParameter( const CATUnicodeString& iProcessName,
const CATUnicodeString& iParamName,
CATBaseUnknown* iObj) = 0
Put a parameter value in the htable. The value must be an object.
Legal values: S_OK If the operation succeeds E_FAIL The operation fails
Parameters:
iProcessName
iParamName
iObj
The object to be pushed in the htable.
o PutParameter
public virtual HRESULT PutParameter( const CATUnicodeString& iProcessName,
const CATUnicodeString& iParamName,
CATUnicodeString* iValue) = 0
Put a parameter value in the htable. The value must be of a primitive type (string).
Legal values: S_OK If the operation succeeds E_FAIL The operation fails
Parameters:
iProcessName
iParamName
iValue
The primitive value to be pushed in the htable.
o RemoveParameter
public virtual HRESULT RemoveParameter( const CATUnicodeString& iProcessName,
const CATUnicodeString& iParamName) = 0
Remove a parameter of whatever type (object or primitive type) from the htable.
Legal values: S_OK If the operation succeeds E_FAIL The operation fails
Parameters:
iProcessName
iParamName

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

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