Retrieve Problem Log Entry (QsxRetrieveProblemLogEntry) API


  Required Parameter Group:

1 Handle Input Binary(4)
2 Key structures Input Array of Pointers
3 Number of keys Input Binary(4)
4 Receiver variable Output Char(*)
5 Length of receiver variable Input Binary(4)
6 Return information Output Char(16)
7 Pointer to array of pointers to the keys returned in the buffer receiver variable Output PTR(SPP)
8 Error code I/O Char(*)

  Default Public Authority: *USE

  Service Program: QSXSRVPL

  Threadsafe: No

The Retrieve Problem Log Entry (QsxRetrieveProblemLogEntry) API allows a user to extract data from a specific problem log entry, which the caller identifies. The problem log entry is identified by key 1 (problem log ID). The data to be retrieved is identified by the keys passed by reference. The keys used to identify the data to be retrieved are not changed by the API.

Data is returned in the receiver variable. If you are supplying an automatically extendable space, specify -1 for the size of the receiver variable. You provide the size and location of this receiver variable. If the receiver variable is not large enough to contain all the keys requested, the keys successfully retrieved to that point are returned. The number of keys returned is set in the return information parameter (number 6).

The API can be used to:


Authorities and Locks

QSXSRVPL authority
*USE
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

List of keys defining the data to be returned.

Number of keys
INPUT; BINARY(4)

Number of keys passed to the API in the input key array.

Receiver variable
OUTPUT; CHAR(*)

The variable that provides the output buffer.

Length of receiver variable
INPUT; BINARY(4)

The size of the output buffer. If it is -1, an automatically extendable space is assumed.

Return information
OUTPUT; CHAR(16)


Pointer to array of pointers to the keys returned in the buffer receiver variable
OUTPUT; PTR(SPP)

The pointer to the array of pointers to the keys returned in the buffer.

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

For details about the keys that can be used, see Key Use for Problem Log APIs.


Rules for Key Usage

Any amount and type of data can be retrieved from the problem log. The limiting factor is the size of the buffer that is available. The data is returned in a buffer up to the size of the buffer.

Data to be retrieved must be identified by the keys provided. Key 1 (problem log ID) is required. All other keys are optional, but only data for valid keys defined is returned.

Data, including PTF entries, can be returned individually or in groups. Data that will be returned as a group are:


Retrieve PTF records

PTF data can be retrieved individually or as a group.

To retrieve all PTFs, use key 7000 (PTF entry). Key 7000 is returned and the count field states how many Key 7001 (PTF ID) keys are returned. For key 7001, the data required includes PTF ID, product ID, version, release, and modification level.

To retrieve individual PTFs, use key 7001 (PTF ID) and add the fields that are to be used as the key. Key 1 (problem log ID) and key 7001 (PTF ID) are required. Product data is optional, but can be required if multiple PTFs have the same PTF identifier.


Retrieve FRU records

To retrieve a FRU group, provide key 2000 (class of FRU entries) and a class. Key 2000 (class of FRU entries) is returned with a count of FRU entries and 2000--2009 are returned.


Retrieve text records

To retrieve the text data, provide key 3000 (text entry) and the text type. Key 3000 (text entry) is returned with a count of key 3001 (text entry) returned. Only one is returned unless all text was requested.


Retrieve supporting data

To retrieve supporting data records, provide key group 4000 (supporting data entries) and the type. Key group 4000 is returned with a count of the entries and key 4001 (spooled file data) and 4002 are returned.


Retrieve history records

To retrieve the history data, provide key 6000 (history information) and specify last or all. Key 6000 (history information) is returned with a count of the history entries and key 6001 (history information) is returned.

Retrieve analyzed error flag:

To retrieve the analyzed eror flag data, provide key 8000 (analyzed error flag entries). Key 8000 returns a value that indicates whether the problem has been analyzed by System Licensed Internal Code (SLIC).

Retrieve logical partition ID:

To retrieve the logical partition ID data, provide key 9000 (logical partition ID). Key 9000 returns the current logical partition ID on the physical machine.


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.
CPD7A82 D Value not valid for key &1. (char string)
CPD7A84 D Buffer area not accessible.
CPD7A87 D Key &1 may be added only once.
CPD7A8A D Key value &1 is not valid.
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 ]