System Interface CATIScriptMethodCall

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

interface CATIScriptMethodCall

Interface to represent a method call used for the macros generation.
Role: A method call consists in :

  • a target on which the method will be invoked,
  • a method name,
  • a list of parameters (one of this parameters can be the returned value).
    • See also:
    ,

    Method Index


    o AddParameter(char,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a char parameter with the specified direction.
    o AddParameter(char*,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a string parameter with the specified direction.
    o AddParameter(float,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a float parameter with the specified direction.
    o AddParameter(short,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a short parameter with the specified direction.
    o AddParameter(double,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a double parameter with the specified direction.
    o AddParameter(CATLONG,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a CATLONG parameter with the specified direction.
    o AddParameter(CATBoolean,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a boolean parameter with the specified direction.
    o AddParameter(CATBSTR&,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a CATBSTR parameter with the specified direction.
    o AddParameter(unsigned long,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke an unsigned long parameter with the specified direction.
    o AddParameter(CATVariant&,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a CATVariant parameter with the specified direction.
    o AddParameter(CATBaseDispatch*,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a CATBaseDispatch parameter with the specified direction.
    o AddParameter(CATSafeArray&,CATScriptParameterDirection,CATBoolean)
    Adds to the method to invoke a CATSafeArray parameter with the specified direction.
    o SetMethodName(CATString&)
    Sets the method name to invoke.
    o SetTarget(CATBaseDispatch*)
    Sets the target on which the method will be invoked.

    Methods


    o AddParameter
    public virtual AddParameter( iChar,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a char parameter with the specified direction.
    Parameters:
    iChar
    The specified char parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( const iString,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a string parameter with the specified direction.
    Parameters:
    iString
    The specified string parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iFloat,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a float parameter with the specified direction.
    Parameters:
    iFloat
    The specified float parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iShort,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a short parameter with the specified direction.
    Parameters:
    iShort
    The specified short parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iDouble,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a double parameter with the specified direction.
    Parameters:
    iDouble
    The specified double parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iLong,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a CATLONG parameter with the specified direction.
    Parameters:
    iLong
    The specified CATLONG parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iBoolean,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a boolean parameter with the specified direction.
    Parameters:
    iBoolean
    The specified boolean parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( const iBSTR,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a CATBSTR parameter with the specified direction.
    Parameters:
    iBSTR
    The specified CATBSTR parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( iULong,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke an unsigned long parameter with the specified direction.
    Parameters:
    iULong
    The specified unsigned long parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( const iVariant,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a CATVariant parameter with the specified direction.
    Parameters:
    iVariant
    The specified CATVariant parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( const iObject,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a CATBaseDispatch parameter with the specified direction.
    Parameters:
    iObject
    The specified CATBaseDispatch parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o AddParameter
    public virtual AddParameter( const iSafeArray,
    iDirection,
    iReturnedParam= FALSE)
    Adds to the method to invoke a CATSafeArray parameter with the specified direction.
    Parameters:
    iSafeArray
    The specified CATSafeArray parameter.
    iDirection
    The specified direction of the parameter.
    iReturnedParam
    The boolean iReturnedParam must be set to TRUE if this parameter is the returned parameter of the method (each method accepts at most one returned parameter).
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o SetMethodName
    public virtual SetMethodName( const iMethodName)
    Sets the method name to invoke.
    Parameters:
    iMethodName
    The specified method name.
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    o SetTarget
    public virtual SetTarget( const iTarget)
    Sets the target on which the method will be invoked.
    Parameters:
    iTarget
    The specified target.
    Returns:
    S_OK if the operation succeeded, E_FAIL otherwise.
    This object is included in the file: CATIScriptMethodCall.h
    If needed, your Imakefile.mk should include the module: JS0GROUP

    Copyright © 1999-2015, Dassault Systèmes. All rights reserved.