XSLPgetfuncinfoV

[Previous] [Next]

XSLPgetfuncinfoV

Purpose

Retrieve the argument information for a user function

Synopsis

int XPRS_CC XSLPgetfuncinfoV(VARIANT *ArgInfo, int *CallFlag, int *nInput, int *nOutput, int *nDelta, int *nInStr, int *nOutStr, int *nSLPUF, int *nInst)

Arguments

ArgInfo

The array of argument information for the user function.

CallFlag

The address of an integer to receive the caller flag value. May be NULL if not required.

nInput

The address of an integer to receive the number of input values. May be NULL if not required.

nOutput

The address of an integer to receive the number of return values. May be NULL if not required.

nDelta

The address of an integer to receive the number of deltas (first derivatives) required. May be NULL if not required.

nInStr

The address of an integer to receive the number of strings in the ARGNAME array. May be NULL if not required.

nOutStr

The address of an integer to receive the number of strings in the RETNAME array. May be NULL if not required.

nSLPUF

The address of an integer to receive the number of the function. May be NULL if not required.

nInst

The address of an integer to receive the instance number for the call. May be NULL if not required.

Example

The following example retrieves the number of the function and the problem pointer. It then retrieves the internal name by which the function is known.
char fName[60];
int fNum;
XSLPprob Prob;
void *Object;

XSLPgetfuncinfo(ArgInfo, NULL, NULL,
                NULL, NULL, NULL, NULL,
                &fNum, NULL);
XSLPgetfuncobjectV(ArgInfo, XSLP_XSLPPROBLEM, &Object);
Prob = (XSLPprob) Object;
XSLPgetnames(Prob, XSLP_USERFUNCNAMES, fName, fNum, fNum);
Further information

This function is identical to XSLPgetfuncinfo except that ArgInfo is of type VARIANT rather than int. It is used in VB or COM functions when the argument information array is passed as one of the arguments. To use this version of the function, pass the first member of array as the first argument to the function — e.g.
XSLPgetfuncinfoV(ArgInfo(0),......)

If any of the addresses is NULL the corresponding information will not be returned.

Related topics

XSLPgetfuncinfo, XSLPsetuserfuncinfo

[Previous] [Next] [Index]

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

ArgInfo	The array of argument information for the user function.
CallFlag	The address of an integer to receive the caller flag value. May be NULL if not required.
nInput	The address of an integer to receive the number of input values. May be NULL if not required.
nOutput	The address of an integer to receive the number of return values. May be NULL if not required.
nDelta	The address of an integer to receive the number of deltas (first derivatives) required. May be NULL if not required.
nInStr	The address of an integer to receive the number of strings in the ARGNAME array. May be NULL if not required.
nOutStr	The address of an integer to receive the number of strings in the RETNAME array. May be NULL if not required.
nSLPUF	The address of an integer to receive the number of the function. May be NULL if not required.
nInst	The address of an integer to receive the instance number for the call. May be NULL if not required.