ucstring

Description

Function ucstring can be used in expressions throughout the scheduling model.

Synopsis


#include "factor.h"

void ucstring(icase, argvalue, type, szBuf, iMax)

int  icase;   /* Integer parameter to function. */
void * argvalue; /* Pointer to the second argument. */
char  type;   /* Type of the second argument. */
char *szBuf;   /* Output: string to return. */
int  iMax;   /* Maximum size of the string to be returned. */

Returns

Nothing.

Note: This function can be used to return strings and names for use in lookup tables or comparison expressions. A reference to ucstring is placed in a system expression. This reference has 2 parameters: 1) icase, an integer (corresponds with icase defined above) and 2)express, an expression. The user then writes a ucstring function with 5 parameters: 1) icase, upon which the function will branch (switch, if-then-else, etc.) if there are multiple different ucstring references in expressions, 2) argvalue, result of an evaluation of the expression (express); 3) type, the type of the expression (‘R’ = double *, ‘I’ = int*, ‘S’ = char*), 4) szBuf, the string to return from the function (output), and 5) iMax, the maximum size of the string to be returned (the default is 255 characters).
Note: The value argvalue will never be “NULL” or (void*) NULL.