udfGetNumUsrHists()

Return the number of user history variables supplied in the input file.

Syntax

nUsrHists = udfGetNumUsrHists( udfHd ) ;

Type

AcuSolve User-Defined Function Basic

Parameters

udfHd
The opaque handle (pointer) which was passed to the user function.

Return Value

nUsrHists (integer)
The returned value is the number of user history variables given in the input file.

Description

This routine returns the number of user history variables supplied in the input file. For example,
Integer nUsrHists ;
...
nUsrHists = udfGetNumUsrHists( udfHd ) ; 
if ( nUsrHists != 2 ) { 
   udfSetError( udfHd, "Invalid number of user history variables %d",
                nUsrHists ) ;
}

Errors

This routine expects a valid udfHd.