QsyFindFirstValidationLstEntry()--Find First Validation List Entry API

  #include <qsyvldl.h>

  int QsyFindFirstValidationLstEntry
         (Qsy_Qual_Name_T        *Validation_Lst,
          Qsy_Rtn_Vld_Lst_Ent_T  *First_Entry);

The QsyFindFirstValidationLstEntry() function finds the first entry in a validation list object. The function then returns the information for the first entry in the buffer that is pointed to by the First_Entry parameter. The entries are stored in hexadecimal sort sequence, so the first entry will be the one where the entry ID has the smallest hexadecimal value.

Authorities

Validation List Object

*USE

Validation List Object Library

*EXECUTE

Note: If the QsyEncryptData attribute is set to QSY_VFY_FIND_E (1), then the user must have *USE, *ADD, and *UPD authority to the validation list to get the data to be encrypted returned in the First_Entry parameter.

Parameters

Validation_Lst

(Input)

A pointer to the qualified object name of the validation list to find the first entry in. The first 10 characters specify the validation list name, and the second 10 characters specify the library. You can use these special values for the library name:

*CURLIB	The current library is used to locate the validation list. If there is no current library, QGPL (general purpose library) is used.
*LIBL	The library list is used to locate the validation list.

First_Entry

(Output)

A pointer to the buffer where the first entry information is placed. The buffer must be allocated to the size of the Qsy_Rtn_Vld_Lst_Ent_T structure or the results will be unpredictable.

The format of the Qsy_Rtn_Vld_Lst_Ent_T structure is as follows:

Qsy_Entry_ID_Info_T	Entry_ID_Info	The entry ID information structure.
Qsy_Entry_Encr_Data_Info_T	Encr_Data_Info	The data to be encrypted information structure.
Qsy_Entry_Data_Info_T	Entry_Data_Info	The entry data information structure.
char	Reserved[4]	This is an ignored field.
void *	Entry_More_Info	A pointer to additional information. This pointer is currently set to NULL.

The format of the Qsy_Entry_ID_Info_T structure is as follows:

int	Entry_ID_Len	The length of the entry ID.
unsigned int	Entry_ID_CCSID	The CCSID associated with the entry ID.
unsigned char	Entry_ID[100]	The entry ID.

The format of the Qsy_Entry_Encr_Data_Info_T structure is as follows:

int	Encr_Data_Len	The number of bytes of encrypted data that is stored in this validation list entry. If the QsyEncryptData attribute is 0 or the QRETSVRSEC system value is '0', the length will always be 0.
unsigned int	Encr_Data_CCSID	The CCSID associated with the encrypted data.
unsigned char	Encr_Data[600]	If the QsyEncryptData attribute is 1 and the QRETSVRSEC system value is '1', then the encrypted data that is stored in the entry will be decrypted and returned in this field. If the QsyEncryptData attribute is 0 or the QRETSVRSEC system value is '0', then the encrypted data cannot be returned, and the contents of this field are unpredictable.

The format of the Qsy_Entry_Data_Info_T structure is as follows:

int	Entry_Data_Len	The length of the entry data.
unsigned int	Entry_Data_CCSID	The CCSID associated with the entry data.
unsigned char	Entry_Data[1000]	The entry data.

Return Value

Error Conditions

If QsyFindFirstValidationLstEntry() is not successful, errno indicates one of the following errors:

Example

The following example finds all the entries in the validation list object WEBUSRS.

Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.

#include <qsyvldl.h>
#include <errno.h>

main()
{
  #define VLD_LST  "WEBUSRS   WEBLIB    "
  Qsy_Rtn_Vld_Lst_Ent_T  entry_1;
  Qsy_Rtn_Vld_Lst_Ent_T  entry_2;
  Qsy_Rtn_Vld_Lst_Ent_T  *input_info,
                         *output_info,
                         *temp;
  Qsy_Entry_ID_Info_T    *input_entry;
  short int              i;
  int                    rtn_errno;

  /* Initialize pointers to input and output buffers.               */
  output_info = addr(entry_1);
  input_info = addr(entry_2);
  /* Get the first entry in the validation list.                    */
  rtn_errno = QsyFindFirstValidationLstEntry(
                             (Qsy_Qual_Name_T *)&VLD_LST,
                             output_info))

  while (0 == rtn_errno)
  { /* Process all the entries in the validation list.              */
          .
          .
          .
     (process the entry)
          .
          .
          .
    /* Switch the pointers to the buffers so that the output from   */
    /* the last find operation is used as input to the 'find-next'
    /* operation.                                                   */
    temp = output_info;
    output_info = input_info;
    input_info = temp;

    /* Find the next entry.                                         */
    rtn_errno = QsyFindNextValidationLstEntry(
                              (Qsy_Qual_Name_T *)&VLD_LST,
                              &input_info->Entry_ID_Info,
                              output_info))
  }
  /* Check if an error occurred.                                    */
  if (0 != rtn_errno && ENOREC != errno)
    perror("Find of validation list entry");

}

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