Community articleFCMGetFunctionCallHelp
Added by IBM contributorIBM on August 16, 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.


This function is used by the API to call the FunctionCall Manager function FCMFunctionCallHelp.


r_short FCMGetFunctionCallHelp(
   r_charP thePackageName,
   r_charP theFunctionName,
   r_u_long *theVersionPtr,
   r_charP *theQuickDescPtr,
   r_charP *theFunctionDescPtr,
   r_charP *theSampleCodePtr,
   r_charP *theArgsNameListPtr,
   r_long *theArgsNameListSizePtr,
   r_charP **theArgsDescListPtr,
   r_long *theArgsDescListSizePtr,
   r_short **theArgsFlagListPtr,
   r_long *theArgsDescListSizePtr,
   r_charP *theRetValDescPtr,
   r_short *theRetValFlagPtr);


Table 1. get function call help parameters
thePackageNamer_charPThe name of the package that contains the function.
theFunctionNamer_charPThe name of the function.
theVersionPtrr_u_long*Pointer to the version number of the function.
theQuickDescPtr r_charP*Pointer to a one-line description of what the function does.
theFunctionDescPtr r_charP*Pointer to a longer more detailed description of the function.
theSampleCodePtr r_charP*Pointer to an example of the XFDL code used to call your function, including an example of the function parameters.
theArgsNameListPtr r_charP**Pointer to a list of arguments that your function takes.
theArgsNameListSizePtrr_long*A pointer to the size of the theArgsNameList.
theArgsDescListPtrr_charP**Pointer to a description of each of the arguments in the theArgsNameList.
theArgsDescListSizePtrr_long*Pointer to the size of theArgsDescList
theArgsFlagListPtrr_short**Pointer to a list of bit flags representing the type of each argument that the function takes. See Notes for more information.
theArgsFlagListSizePtrr_long*Pointer to the size of theArgsFlagList
theRetValDescPtrr_charP*Pointer to a description of your custom function's return value.
theRetValFlagPtrr_short*Pointer to a bit flag representing the type of the return value. See Notes for more information. Simply use UFLSetLiteralEx on this object to store the result.


OK on success or an error code on failure.


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


In the example below the function another_test_Package.multiply uses FCMGetFunctionCallHelp to call the help function that was defined for the test_Package.multiply function.
r_short FCISimpleHelp(FunctionCall *theObject,r_charP thePackageName, 
   r_charP theFunctionName, 
r_u_long theFunctionID, IFSUserData **theFunctionDataPtr, 
   r_charP *theQuickDescPtr, r_charP 
*theFunctionDescPtr, r_charP *theSampleCodePtr, r_charP **theArgsNameListPtr, 
*theArgsNameListSizePtr, r_charP **theArgsDescListPtr, 
   r_long *theArgsDescListSizePtr, r_short 
**theArgsFlagListPtr, r_long *theArgsFlagListSizePtr, r_charP *theRetValDescPtr, 
/* Switch on theFunctionID. This makes it easy for a single FunctionCall
      to support multiple functions. */
/* Remember that you must define an ID number for each custom function
      that you create. In the example below the constant FCI_MULTIPLY_ID
      represents the identification number for the multiply function. */
         case FCI_MULTIPLY_ID:
            FCMGetFunctionCallHelp("test_Package", "multiply",theVersion,
               theQuickDesc, theFunctionDesc, theSampleCode,
               theArgsNameListPtr, theArgsNameListSize, theArgsDescListPtr,
               theArgsDescListSizePtr, theArgsFlagListPtr,
               theArgsFlagListSizePtr, theRetValDesc, theRetValFlag);                     
               /* Additional Code Removed */