HP 3000 Manuals HP 3000 Manuals
HPDExplain
______________________________________________________
| |
| S I BA I |
| HPDExplain (status, code, message, msg_length);|
______________________________________________________
HPDExplain returns a one line text message relating to the error code
resulting from one of the other Intrinsic calls, or the result code in a
returned record in the Transaction File.
status
Required, by Reference; type = STATUS_TYPE.
Used to return information from the Intrinsic.
This gives the overall result of the operation. It does not matter what
it contains when the Intrinsic is called.
code
Required, by Reference; type = INTEGER.
Used to supply information to the Intrinsic.
This contains a status number for which the text message is required,
taken from status[1] or a transaction record result field.
message
Required, by Reference; type = BYTE ARRAY, length = at least 80 bytes and
up to 255 bytes.
Used to return information from the Intrinsic.
This is the byte array into which the text message is to be returned.
msg_length
Required, by Reference; type = INTEGER.
Used to supply information to and return information from the Intrinsics.
On input, this parameter contains the maximum number of bytes that can be
accommodated in the message buffer, and must have a value in the range 0
to 255. It will be updated with the actual number of bytes in the
buffer.
General Information about HPDExplain
HPDExplain can be called without first signing on to a user or gateway
and the HP Desk user interface (USERINT) and the gateway Intrinsics
(GATEINT) need not be enabled.
HPDExplain provides a means for an application to extract an explanatory
message in the current localized language for any given error condition
that can result from a call to the HP Desk Intrinsics. The messages are
contained in a message catalogue that is supplied with the HP Desk
Intrinsics. They are listed in Appendix B. Because the Intrinsics Driver
process is responsible for retrieving messages from the catalogue, it is
not possible for messages belonging to certain error conditions to be
returned, for example, "Product not installed" or "Problem with creating
Driver process". The value returned in status[1] by HPDExplain indicates
when this is the case.
Status Returns Specific to HPDExplain
-400 Cannot access first parameter
-401 Cannot access second parameter
-402 Cannot access third parameter
-403 Cannot access fourth parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-1004 The HP Desk Intrinsics product is not installed
-1005 HP Desk Intrinsics software and message catalogue
are incompatible
-1009 No MPE system resource (CreateProcess Error 4)
-1010 Cannot load Intrinsics Driver program
-1011 HP Desk and HP Desk Intrinsics software and message
catalogue are incompatible
-1900 Unexpected errors
-7200 Message length is invalid
-7201 No message exists for supplied code
-7202 The message is longer than the supplied message
length