[Contents]

3. Embedding the Interpreter

3.3. ScriptBasic C API

3.3.57. scriba_CallArg()

This function can be used to call a function or subroutine with arguments passed by value. Neither the return value of the SUB nor the modified argument variables are not accessible via this function. CallArg is a simple interface to call a ScriptBasic subroutine or function with argument.

int scriba_CallArg(pSbProgram pProgram,
                   unsigned long lEntryNode,
                   char *pszFormat, ...
  ){

• pProgram is the class variable.
• lEntryNode is the start node of the SUB. (See @xref{scriba_Call()} note on how to get the entry node value.)
• pszFormat is a format string that defines the rest of the areguments

The format string is case insensitive. The characters u, i, r, b and s have meaning. All other characters are ignored. The format characters define the type of the arguments from left to right.

• u means to pass an undef to the SUB. This format character is exceptional that it does not consume any function argument.
• i means that the next argument has to be long and it is passed to the BASIC SUB as an integer.
• r means that the next argument has to be double and it is passed to the BASIC SUB as a real.
• s means that the next argument has to be char * and it is passed to the BASIC SUB as a string.
• b means that the next two arguments has to be long cbBuffer and unsigned char *Buffer. The cbBuffer defines the length of the Buffer.

Note that this SUB calling function is a simple interface and has no access to the modified values of the argument after the call or the return value.

If you need any of the functionalities that are not implemented in this function call a more sophisticated function.

Example:

  iErrorCode = scriba_CallArg(&MyProgram,lEntry,"i i s d",13,22,"My string.",54.12);