Delete Keystore Record Exit Program


  Required Parameter Group:

1 Delete keystore record key exit information Input Char(*)
2 Action Input Char(1)
3 Delete status Output Char(*)

  QSYSINC Member Name: EDLTKR

  Exit Point Name: QIBM_QC3_DLT_KREC

  Exit Point Format Name: DLKR0100

The Delete Keystore Record exit program is called when the Remove Keystore File Entry (RMVCKMKSFE) CL command, the Qc3DeleteKeyRecord API, or the delete action of the Key Store Contents panel in System i® Navigator is being used.

The operating system calls the user-written exit programs through the registration facility for each keystore file.

The exit point supports an unlimited number of exit programs. For information about adding an exit program to an exit point, see the Registration Facility.


Authorities and Locks

None.


Required Parameter Group

Delete Keystore Record exit information
INPUT; CHAR(*)

Information that is needed by the exit program for notification of a keystore record that is to be deleted. For details, see Format of Delete Keystore Record Exit Information.

Action
INPUT; CHAR(1)

The type of exit program call being made. The following actions may be requested:

1 Check The exit program is being called before the key record is deleted. The exit program should determine if the key record can be deleted and perform any necessary pre-processing actions. The exit program should set the Delete status value appropriately.
2 Execute The exit program is being called after a key record has been deleted successfully. The exit program should perform any necessary post-processing actions.
3 Cancel The exit program is being called because another exit program has returned a Delete status indicating the key record is not eligible to be deleted. You may need to back out pre-processing actions.
Delete status
OUTPUT; CHAR(*)

Information that is returned by the exit program. For details, see Format of Status Information.

Note: The information returned is ignored when the action parameter is set to 2 or 3.


Format of Delete Keystore Record Exit Information

The following table shows the structure of the delete keystore record exit information. For a description of the fields in this format, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 Binary(4) Delete keystore record exit information length
4 4 Char(32) Record label
36 24 Char(20) Qualified keystore file name


Format of Status Information

The following table shows the structure of the Delete status information. For a description of the fields in this format, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 Binary(4) Delete keystore record status length
4 4 Char(1) Delete keystore record status


Field Descriptions

Delete keystore record exit information length. The length of the delete keystore record exit information.

Delete keystore record status. The status value that indicates whether the exit program considers the keystore record eligible to be deleted. The possible values are:

0 The keystore record is not eligible to be deleted. Therefore, the Remove Keystore File Entry command or Delete Keystore Record API will end and the keystore record will not be deleted.
1 The keystore record is eligible to be deleted.

Note: If any other value is specified for this field, the keystore record will not be eligible to be deleted.

Delete keystore record status length. The length in bytes of the delete status information.

Qualified keystore file name. The file name of the keystore to be deleted. The following table shows the structure of this field:

Offset Type Field
Dec Hex
0 0 Char(10 Library name
4 4 Char(10) File name

Record label. The label of the key record. The label will be converted from CCSID 1200 (Unicode UTF-16) to the job CCSID, or if 65535, the job default CCSID (DFTCCSID) job attribute.


Exit program introduced: V6R1

[ Back to top | Cryptographic Services APIs | APIs by category ]