Retrieve Server Authentication Entries (QSYRTVSE, QsyRetrieveServerEntries) API


Required Parameter Group for QSYRTVSE:


  Default Public Authority: *USE

  Threadsafe: No



  Syntax for QsyRetrieveServerEntries:
 #include <qsysvrfn.h>

 void QsyRetrieveServerEntries
        (void                        *Receiver_variable,
         int                          Length_of_receiver_variable,
         Qsy_RSVRE_Feedback_Info_T   *Return_records_feedback_information,
         char                        *Format_name,
         char                        *Starting_server_name,
         int                          Length_of_starting_server_name,
         char                         Starting_server_option,
         char                         User_profile[10],
         void                        *Error_code);
  Service Program: QSYSVRFN

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve Server Authentication Entries (OPM, QSYRTVSE; ILE, QsyRetrieveServerEntries) API returns a list of server authentication entries for a user profile.

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


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 server authentication entries for the user profile.

You can specify this format:


Starting server name
INPUT; CHAR(*)

The server name at which to start listing server authentication entries. The server authentication entries are listed in hexadecimal sort sequence by server name.

Possible values follow:


Length of starting server name
INPUT; BINARY(4)

The length of the starting server name. The length of the starting server name may be from 1 to 200.

Starting server option
INPUT; CHAR(1)

This parameter indicates whether the starting server authentication entry is returned when an exact match for the starting server name is found.

Possible values follow:


User profile
INPUT; CHAR(10)

The name of the user profile for which the server authentication entries are returned.

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.


SVRE0100 Format



Format of Returned Records Feedback Information



Field Descriptions

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 server authentication 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 server name. The CCSID of the server name. This will be the default job CCSID of the job that added the server authentication entry.

CCSID of user ID. The CCSID of the user ID. This will be the default job CCSID of the job that last changed the user ID field in the server authentication entry.

Displacement to user ID. The displacement in the entry to the start of the user ID.

Format name. The name of the format that is used to return server authentication entries for a user profile.

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

Length of server name ID. The length (in bytes) of the server name.

Length of user ID. The length (in bytes) of the user ID.

Number of server authentication entries. The number of complete entries returned in the list of server authentication entries. A value of zero is returned if the list is empty.

Password specified. Indicates whether the server authentication entry has a password associated with it.

Possible values follow:

Server name. The name of the server that the entry is for.

User ID. The user ID that is used on requests to the server.

User profile. The name of the user profile for which the list of server authentication entries is returned.


Error Messages

API introduced: V4R2

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