[Contents]

3. Embedding the Interpreter

3.3. ScriptBasic C API

3.3.59. scriba_NewSbArgs()

Whenever you want to handle the variable values that are returned by the scriba subroutine you have to call @xref{scriba_CallArgEx()}. This function needs the arguments passed in an array of SbDtata type.

This function is a usefuly tool to convert C variables to an array of SbData

pSbData scriba_NewSbArgs(pSbProgram pProgram,
                         char *pszFormat, ...
  ){

• pProgram is the class variable
• pszFormat is the format string

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 leng of the Buffer.

Example:

pSbData MyArgs;


  MyArgs = scriba_NewSbArgs(pProgram,"i i r s b",13,14,3.14,"string",2,"two character string");
  if( MyArgs == NULL )error("memory alloc");

  scriba_CallArgEx(pProgram,lEntry,NULL,5,MyArgs);

This example passes five arguments to the ScriptBasic subroutine. Note that the last one is only two character string, the rest of the characters are ignored.