[Previous] [Next]

SLPgetfuncinfo

---

Purpose

Obtain additional information for a user function

Synopsis

function SLPgetfuncinfo(FuncInfo:array(FR:range) of integer, Param: integer) :integer

Arguments

FuncInfo

The function information array for the function. When SLPgetfuncinfo is used within a user function, FuncInfo is normally the second argument to the function.

Param

The item required. The value is one of the following: xslpinfo_callerflag Returns the CallerFlag parameter xslpinfo_ninput Returns the number of input variables xslpinfo_noutput Returns the number of return variables xslpinfo_ninstring Returns the number of items in the input string array xslpinfo_noutstring Returns the number of items in the output string array xslpinfo_funcnum Returns the number of the function being called xslpinfo_instance Returns the instance number of the function being called

Return value

the value indicated by Param

Example

The following code fragment (from within a Mosel user function) uses SLPgetfuncinfo to find the number of input variables (the number of items actually used in InArray):

function MyArea(InArray:array(IR:range) of real,
                nArray:array(NR:range) of integer): real
...
N := SLPgetfuncinfo(nArray,xslpinfo_ninput)

Related topics

SLPcalluserfunc, SLPsetuserfuncinfo

[Previous] [Next] [Index]

---

If you have any comments or suggestions about these pages, please send mail to docs@dashoptimization.com.