Initializing help system before first use

XPRMProcedure Properties

The XPRMProcedure type exposes the following members.

Properties
  Name Description
Public property IsInitialised Checks whether this value is initialized
(Overrides XPRMValueIsInitialised)
Public property Model Used to fetch the XPRM model to which this object belongs, or else 'null' if there is no model anywhere among this Object's ancestors.
(Inherited from XPRMObjectBase)
Public property Name Property to get this identifier's name
Public property NbParameters Number of parameters (arguments) expected by the subroutine.
Public property Owner Used to fetch the XPRM object to which this object belongs
(Inherited from XPRMObjectBase)
Public property ParameterTypes The string of parameter types. This is a text string describing which arguments are expected by the function: it is its signature. This string is composed with the following characters:
  • i – an integer;
  • r – a real;
  • s – a text string;
  • b – a Boolean;
  • v – a decision variable (type mpvar);
  • c – a linear constraint (type linctr);
  • I – a range set;
  • a – an array (of any kind);
  • e – a set (of any type);
  • |xxx| – external type named 'xxx';
  • !xxx! – the set named 'xxx';
  • Andx.t – an array indexed by 'ndx' of the type 't'. 'ndx' is a string describing the type of each indexing set. 'ndx' may be omitted, in which case any array of type 't' is a valid parameter;
  • Et – a set of type 't'.
For instance, the procedure: proc(n:integer, tab:array(range, set of real, myset) of string, flag:boolean) has the signature 'iAIr!myset!.sb'.
Public property ReturnType Numeric type code for return value of the procedure. A combination of TYP_*, STR_* and GRP_* values. For module procedures returned by Procedures, this may be (int)XPRMVarType.EXTN in which case the type name can be fetched from the ReturnTypeName propery.
Public property ReturnTypeName Name of the return type of this procedure
Public property StructCode
(Inherited from XPRMTypedObject)
Public property StructName
(Inherited from XPRMTypedObject)
Public property Type
(Inherited from XPRMTypedObject)
Public property TypeCode
(Inherited from XPRMTypedObject)
Public property TypeName
(Inherited from XPRMTypedObject)
Top
See Also
Covered Topics
Parent Topic XPRMProcedure Class

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.