udfGetUgdData()

Return the value of a user global data.

Syntax

ugdData = udfGetUgdData( udfHd, ugd ) ;

Type

AcuSolve User-Defined Function Global

Parameters

udfHd: The opaque handle (pointer) which was passed to the user function.
ugd (string): Name of the user global data variable.

Return Value

ugdData (real): Value of the user global data.

Description

This routine returns the value of the specified user global data. If the user global data has not been set, then it is set with a value of zero. For example,

Real ugdData ;
...
ugdData = udfGetUgdData( udfHd, "nCols" ) ;

Errors

This routine expects a valid udfHd.
ugd must exist.