AppCtrlScript

MAY Computer

Help

ADDINCALL

Applies to  

AppCtrlScript (Module: wmACScr1.dll)

Group  

Execution

See also  

RUNSCRIPT, SHOWDIDIFORM

Creates a an addin class object (provided by an activex DLL or EXE) and performs the RunAction method of the activex DLL or activex EXE.

Parameter can be any parameter string.

Note: Only one parameter can be passed to the AddIn method but you can pass more informations by building one parameter string containing all parameters (for example "MyPar1=123 MyAction=DOALL") and split them in the AddIn method when receiving the parameter.

The Addin class must support the following method (sub or function):

RunAction(ByVal Param As String, ByRef Vars As cVarCol)

(when referencing wmGlob1 in project references) or (without this reference):

RunAction(ByVal Param As String, ByRef Vars As Variant)

The Vars object represents a collection of current script variables.

You do not need to pass a bulk of information to your plugin. Use Vars.GetVal("YourVarName") function to retrieve the contents of a script variable. You can return one or more values to the calling script by simply using Vars.SetVal "MyVarName", <Value>.

You can also access some objects used by the ACScript itself including objects that are provided by used language extensions. To enable access to these objects use 1 for the Addobjects parameter of ADDINCALL and further you must have the following additional property in your AddIn class:

Public Property Get AvailObjs() As cObjList
Public Property Set AvailObjs(ByRef pAvailObjs As cObjList)

(when referencing wmGlob1 in project references) or (without this reference):
Public Property Get AvailObjs() As Variant
Public Property Set AvailObjs(ByRef pAvailObjs As Variant)
For details about how to create AddIns contact MAY Computer for help and to obtain samples.
 

Syntax

ADDINCALL <ClassName>[, <Parameter>][, <AddObjects>] 

Part

Description

<ClassName> AddIn class name.
<Parameter> Optional parameter string.
<AddObjects> 0|1, optional flag if script objects will be used in AddIn. Default is 0 (deactivated).

 

Samples

ADDINCALL MyAddIn.Sample, "MyParameter", "0"