udfGetName()

Return the user-given name of the input command associated with the user function.

Syntax

name = udfGetName( udfHd ) ;

Type

AcuSolve User-Defined Function Basic

Parameters

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

Return Value

name (string)
The returned string value is the User-given name of the input command calling this user function.

Description

This routine returns the user-given name of the input command associated with the user function. This facilitates correlating with the input file. For example,
String user_name ;
...
user_name = udfGetName( udfHd ) ;
udfPrintMess( "Inside command with name <%s>", user_name ) ;

Errors

This routine expects a valid udfHd as an argument; an invalid argument returns an error.