Retrieve User Application Information (QsyRetrieveUserApplicationInfo) API

Syntax for QsyRetrieveUserApplicationInfo:

 #include <qsyusrin.h>

 void QsyRetrieveUserApplicationInfo
        (void           *Receiver_variable,
         int            *Length_of_receiver_variable,
         void           *Return_records_feedback_information,
         char           *Format_name,
         char           *User_profile,
         char           *Application_information_ID,
         int            *Length_of_application_information_ID,
         void           *Error_code);

  Service Program: QSYUSRIN

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve User Application Information (QsyRetrieveUserApplicationInfo) API returns a list of application information entries for a user profile.

Authorities and Locks

User Profile Authority: *READ

Required Parameter Group

Receiver variable

OUTPUT; CHAR(*)

The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.

Length of receiver variable

INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable.

Returned records feedback information

OUTPUT; CHAR(12)

Information about the entries that are returned in the receiver variable.

See Format of Returned Records Feedback Information for details.

Format name

INPUT; CHAR(8)

The name of the format that is used to retrieve application information entries for the user profile.

You can specify this format:

RUAI0100

For a detailed description of this format, see RUAI0100 Format.

User profile

INPUT; CHAR(10)

The name of the user profile for which the application information will be retrieved. The special value *CURRENT may be specified to retrieve application information for the user profile that calls this API.

Application information ID

INPUT; CHAR(*)

The ID for the application information to retrieve. The following can be specified for the application information ID:

generic*: All application information IDs that have IDs beginning with the generic string will be retrieved.
application information ID: Specific application information ID will be retrieved.

Length of application information ID

INPUT; BINARY(4)

The length of the application information ID. The length of the application information ID may be from 1 to 200.

Error code

I/O; CHAR(*)

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

Receiver Variable Description

The following tables describe the order and format of the data returned in the receiver variable. For detailed descriptions of the fields in the tables, see Field Descriptions.

RUAI0100 Format

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Length of entry
4	4	CHAR(200)	Application information ID
204	CC	BINARY(4)	Displacement to user application information
208	D0	BINARY(4)	Length of user application information
212	D4	BINARY(4)	CCSID of user application information
216	D8	CHAR(6)	First valid release
		CHAR(*)	User application information

Format of Returned Records Feedback Information

Offset		Type	Field
Dec	Hex	Type	Field
0	0	BINARY(4)	Bytes returned
4	4	BINARY(4)	Bytes available
8	8	BINARY(4)	Number of user application information entries

Field Descriptions

Application information ID. The application information ID that identifies this entry.

Bytes available. The number of bytes of data available to be returned to the user in the receiver variable. If all data is returned, bytes available is the same as the number of bytes returned. If the receiver variable was not large enough to contain all of the data, this value is estimated based on the total number of application information entries for the user profile and the format specified.

Bytes returned. The number of bytes of data returned to the user in the receiver variable. This is the lesser of the number of bytes available to be returned or the length of the receiver variable.

CCSID of user application information. The CCSID of the user application information. This will be the default job CCSID of the job that last updated the user application information.

Displacement to user application information. The displacement in the entry to the start of the user application information.

First valid release. The first release that this application information is valid. This field will be in the format VxRxMx (for example, V5R3M0).

Length of entry. The length (in bytes) of the current entry. This length can be used to access the next entry.

Length of user application information. The length (in bytes) of the user application information.

Number of user application information entries. The number of complete entries returned in the list of user application information entries. A value of zero is returned if the list is empty.

User application information. The user application information that is associated with the user profile.

Error Messages

Message ID	Error Message Text
CPFA0AA E	Error occurred while attempting to obtain space.
CPF2204 E	User profile &1 not found.
CPF2213 E	Not able to allocate user profile &1.
CPF2217 E	Not authorized to user profile &1.
CPF2222 E	Storage limit is greater than specified for user profile &1.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3C21 E	Format name &1 is not valid.
CPF3C90 E	Literal value cannot be changed.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V5R3

[ Back to top | User Application APIs | APIs by category ]