Community articlegetFunctionCallHelp method
Added by IBM contributorIBM on August 15, 2011
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.



Description

This method is used by the API to call the FunctionCall method help.

Method

public void getFunctionCallHelp(
   String thePackageName, 
   String theFunctionName,
   int theFlagsPtr,
   com.PureEdge.IntHolder theVersion, 
   com.PureEdge.StringHolder theQuickDesc, 
   com.PureEdge.StringHolder theFunctionDesc, 
   com.PureEdge.StringHolder theSampleCode, 
   com.PureEdge.StringListHolder theArgsNameList, 
   com.PureEdge.StringListHolder theArgsDescList, 
   com.PureEdge.ShortListHolder theArgsFlagList, 
   com.PureEdge.StringHolder theRetValDesc, 
   com.PureEdge.ShortHolder theRetValFlag
  ) throws UWIException;


Parameters

ExpressionTypeDescription
thePackageNameStringThe name of the package that contains the function.
theFunctionNameStringThe name of the function.
theFlagsPtrintReturns the flags that were set when the function was registered with registerFunctionCall.
theVersionIntHolderThe version number of the function.
theQuickDesc StringHolderA short, one-line description of what the function does.
theFunctionDesc StringHolderA longer more detailed description of the function.
theSampleCode StringHolderProvides an example of the XFDL code used to call your function, including an example of the function parameters.
theArgsNameList StringListHolderA list of arguments that your function takes.
theArgsDescList StringListHolderA description of each of the arguments in the theArgsNameList.
theArgsFlagListShortListHolderA list of bit flags representing the type of each argument that the function takes. See Notes for more information.
theRetValDescStringHolderA description of your custom function's return value.
theRetValFlagShortHolderA bit flag representing the type of the return value. See Notes for more information. Simply use setLiteralEx on this object to store the result.


Returns

Nothing if call is successful or throws a generic exception (UWIException) if an error occurs.

Notes

Refer to the table of FunctionCall Class Constants API 4 JavaCreate New Article for possible values for:
  • theArgsFlagList
  • theRetValFlag

Example

In the example below the function my_package.multiply uses the getFunctionCallHelp method to call the function help that was defined for the sample_package.multiply function.
   public void help(String thePackageName, 
      String theFunctionName, int theFunctionID, 
      com.PureEdge.IFSUserDataHolder theFunctionData, 
      com.PureEdge.StringHolder theQuickDesc, 
      com.PureEdge.StringHolder theFunctionDesc, 
      com.PureEdge.StringHolder theSampleCode, 
      com.PureEdge.StringListHolder theArgsNameList, 
      com.PureEdge.StringListHolder theArgsDescList, 
      com.PureEdge.ShortListHolder theArgsFlagList, 
      com.PureEdge.StringHolder theRetValDesc, 
      com.PureEdge.ShortHolder theRetValFlag) throws UWIException
   {
      /* Additional Code Removed */
      switch(theFunctionID)
      {
      case myFC.MULTIPLY:
         IntHolder theVersion = new IntHolder( );
         theFCM.getFunctionCallHelp("sample_package", "multiply",
            theVersion, theQuickDesc, theFunctionDesc, theSampleCode, 
            theArgsNameList, theArgsDescList, theArgsFlagList, 
            theRetValDesc, theRetValFlag); 
         break;
      }
   }