Retrieve Function Usage Information (QSYRTFUI, QsyRetrieveFunctionUsageInfo) API

  Required Parameter Group for QSYRTFUI:

  Default Public Authority: *USE

  Threadsafe: Yes

  Syntax for QsyRetrieveFunctionUsageInfo:
 #include <qsyfnusg.h>

 void QsyRetrieveFunctionUsageInfo
        (void    *Receiver_variable,
         int     *Length_of_receiver_variable,
         char     Format_name[8],
         char     Function_ID[30],
         void    *Error_code);

  Service Program: QSYFNUSG
  Default Public Authority: *USE

  Threadsafe: Yes

The Retrieve Function Usage Information (OPM, QSYRTFUI; ILE, QsyRetrieveFunctionUsageInfo) API retrieves usage information for a function.

The QSYS2.FUNCTION_USAGE view can be used as an alternative to this API. See FUNCTION_USAGE view for more information.

Authorities and Locks

API Public Authority
Authority Required
*SECADM special authority
Usage Information Lock

Required Parameter Group

Receiver variable

The variable that is to receive the function usage information.

Length of receiver variable

The length of the receiver variable. If the length is larger than the size of the receiver variable, the results may not be predictable. The minimum length is 8 bytes.

Format name

The format of the function usage information to be returned.

You must use the following format name:

Function ID

The ID of the function for which usage information is being retrieved.

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

FNUI0100 Format

The following information is returned for the FNUI0100 format. This format provides usage information for a function. For a detailed description of each field, see Field Descriptions.

Field Descriptions

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Length of function usage entry. The length of a function usage entry that is returned. This value should be used in determining the displacement to the next function usage entry.

Number of function usage entries returned. The number of function usage entries returned. If the receiver variable is not large enough to hold all of the information, this number contains only the number of function usage entries actually returned.

Offset to first function usage entry. The offset to the first function usage entry returned. The offset is from the beginning of the structure. If no entries are returned, the offset is set to zero.

Reserved. An ignored field.

Usage setting. Whether the user profile is allowed to use the function or not.

The possible values follow:

User profile name. The name of the user profile that has a usage setting for this function.

User profile type. Whether the user profile is a user or a group.

The possible values follow:

Error Messages

API introduced: V4R3

[ Back to top | Security APIs | APIs by category ]