Delete Problem Log Entry (QsxDeleteProblemLogEntry) API

Required Parameter Group:

1	Handle	Input	Binary(4)
2	Key structures	Input	Array of Pointers
3	Number of keys	Input	Binary(4)
4	Error code	I/O	Char(*)

  Default Public Authority: *USE

  Service Program: QSXSRVPL

  Threadsafe: No

The Delete Problem Log Entry (QsxDeleteProblemLogEntry) API provides one of the following functions:

Deletes a single problem log entry.
The problem log entry and all associated data is deleted.
Removes data from a problem log entry.

The data that can be removed by the API are:

Key group 2000 (FRU entries). Either all FRU entries or all FRU entries of a class are removed. Individual FRU entries cannot be removed.
Key group 4000 (supported data entries). Either all supporting data entries are removed or all entries of a type.
PTF entries can be deleted individually, using key 7001 (PTF ID), or they can be deleted entirely using key 7000 (PTF entry).

Authorities and Locks

API Public Authority: *USE

Required Parameter Group

Handle: INPUT; BINARY(4)
An identifier that associates the problem log services started with the QsxStartProblemLogServices API.
Key structures: INPUT; Array of Pointers
Array of pointers to the data contained in each key being passed to the API.
Number of keys: INPUT; BINARY(4)
Tells the API how many keys are being passed to it.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

Format of the Key Groups

Depending on the type of problem entry being deleted, one or more key groups must be provided to remove the data required or desired to the problem. You must select the keys applicable to the problem data you are deleting. If the keys provided to the API do not match the requirements for the problem log entry type you are deleting, you are notified by the error handling procedures.

For details about the keys that may be used see Key Groups for Problem Log APIs.

Rules for Key Usage

The Delete Problem Log Entry API can be used to:

Delete the problem log entry.
To delete specific entries from the problem log.
The specific data that can be deleted are:
- Key 2000 (class of FRU entries) to remove all FRU entries or all FRU entries of a class
- Key 7000 (PTF entry) to remove all PTF entries
- Key group 4000 (supporting data entries) to remove all supporting data entries, or all spooled file entries or all data file records as a group. Individual entries cannot be removed.
- Key 7001 (PTF ID) to remove a single PTF entry

Deleting the above in any combination is supported.

The status of a problem log is not changed as a result of the delete operation.

Delete a Problem Log Entry

To delete a problem log entry, provide a key 1 (problem log ID) with no other keys. This deletes the problem log entry and all associated data. To delete the problem, it must be in CLOSED status or be older than the period defined by system value QPRBHLDITV.

Delete FRU Entries

Individual FRU entries cannot be deleted. FRU entries are deleted by class. For example, to delete the point of failure FRUs, use key 2000 and set the class field to 1. All point of failure FRUs are deleted.

Delete PTF Entries

PTF entries can be deleted individually, using key 7001 (PTF ID), or they can be deleted entirely using key 7000 (PTF entry).

Delete Supporting Data

Individual supporting data entries cannot be deleted. The entry in the problem log is deleted and the data defined by the entry is also deleted. For example, if a spooled file entry is defined, the problem log contains the name of the object to be deleted. The spooled file and the problem log entry containing the spooled file name are both deleted. Provide the following data:

Key 1 (problem log ID)
Key group 4000 (supported data entries) deletes all entries or all entries of a type.

Error Messages

Message ID	Error Message Text
CPF3C1E E	Required parameter &1 omitted.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPF7AAB E	Problem &1 not found.
CPF3C4D D	Length &1 for key &2 not valid.
CPF3C82 D	Key &1 not valid for API &2.
CPF3C86 D	Required key &1 not specified.
CPF7AA6 D	Problem record &1 cannot be deleted.
CPD7A82 D	Value not valid for key &1. (char string)
CPD7A87 D	Key &1 may be added only once.
CPD7A89 D	Record &1 was not deleted.
CPD7A8A D	Key value &1 is not valid.
CPF7A89 E	Incorrect handle for this activation.
CPF7A8A E	Problem log services not started.
CPF7AA6 E	Problem record &1 cannot be deleted.
CPF7AA7 E	Problem &1 not found.
CPF9821 E	Not authorized to program &1 in library &2.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.
CPFA320 E	Pointer parameter is null.

API introduced: V3R1

[ Back to top | Problem Management APIs | APIs by category ]