LitDev Extension API
LDCall
Call Functions with arguments, asyncronously from any extension or from a pre-compiled SmallBasic exe.
CallAsync
|
CallComplete
|
CallInclude
|
|
CallIncludeWithVars
|
Compile
|
Compiler
|
|
Function
|
Function2
|
Function3
|
|
Function4
|
Function5
|
Include
|
|
LastCall
|
LastResult
|
CallAsync(dll,extension,obj,method,arguments)
Call any extension method asynchronously.
See example LDCallAsync.
If dll, extension, obj and arguments are all "", then method may be a subroutine in your SmallBasic program.
dll The extension dll (e.g. "LitDev.dll" or "SmallBasicLibrary.dll").
extension The extension namespace (usually the same as the dll name, e.g. "LitDev" or "MicroSoft.SmallBasic.Library" for SmallBasicLibrary.dll).
obj The extension object name.
method The extension method name.
arguments An array of arguments or "" for none. A single argument doesn't have to be in an array.
returns "PENDING" or an error message on failure.
CallComplete
Event when an asynchronous subroutine method call completes.
CallInclude(include,method)
Call a method in an included pre-compiled file.
All main program variables are shared with the called subroutine.
include The include file name returned by Include method.
method The subroutine name to call in the included exe.
returns "SUCCESS" or "FAILED".
CallIncludeWithVars(include,method,input,output)
Call a method in an included pre-compiled file, specifying dynamic input and output parameters.
If both of these are "", then all variables will be copied in and back from this call, which is equivalent to the CallInclude method.
Unset variable values in the included subroutine persist between calls.
include The include file name returned by Include method.
method The subroutine name to call in the included exe.
input An array of variable names that will be copied to the subroutine.
If this is "", then all variables will be copied to the subroutine.
output An array of variable names that will be copied back from the subroutine.
If this is "", then the same input variables will be copied back from the subroutine.
returns "SUCCESS" or "FAILED".
Compile(path)
Compile a secondary Small Basic file.
Assumes that Small Basic is installed in the default location for your OS.
path A Small Basic file to compile (.sb).
returns The path of the compiled file (.exe) or "" on failure.
Compiler
Set or get the path to the Small Basic compiler for use with Compile method. If unset the default location will be used.
Function(funcName,arg1)
Call a Small Basic Sub as a function with one input argument.
The input arguments(s) will be copied to an array called "args".
The result should be put in a variable (may be an array) called "return".
The variable "args" should be set to "" at the start of the program.
The input parameter(s) are unchanged, while "args" and "return" are set to "" on return.
funcName The Small Basic Sub name.
arg1 An input value (may be an array).
returns The result of the function held in optional variable "return" or an error message.
Function2(funcName,arg1,arg2)
Call a Small Basic Sub as a function with two input arguments.
See Function for more details.
funcName The Small Basic Sub name.
arg1 1st input value (may be an array).
arg2 2nd input value (may be an array).
returns The result of the function held in variable "return" or an error message.
Function3(funcName,arg1,arg2,arg3)
Call a Small Basic Sub as a function with three input arguments.
See Function for more details.
funcName The Small Basic Sub name.
arg1 1st input value (may be an array).
arg2 2nd input value (may be an array).
arg3 3rd input value (may be an array).
returns The result of the function held in variable "return" or an error message.
Function4(funcName,arg1,arg2,arg3,arg4)
Call a Small Basic Sub as a function with four input arguments.
See Function for more details.
funcName The Small Basic Sub name.
arg1 1st input value (may be an array).
arg2 2nd input value (may be an array).
arg3 3rd input value (may be an array).
arg4 4th input value (may be an array).
returns The result of the function held in variable "return" or an error message.
Function5(funcName,arg1,arg2,arg3,arg4,arg5)
Call a Small Basic Sub as a function with five input arguments.
See Function for more details.
funcName The Small Basic Sub name.
arg1 1st input value (may be an array).
arg2 2nd input value (may be an array).
arg3 3rd input value (may be an array).
arg4 4th input value (may be an array).
arg5 5th input value (may be an array).
returns The result of the function held in variable "return" or an error message.
Include(path)
Reference a previously compiled program to use a subroutine method from.
path The full path to a secondary compiled Small Basic program to use (.exe)
returns A name for the include file or "" on failure.
LastCall
The last asynchronous call name.
LastResult
The last asynchronous call return value.