RSC/MP Programming Manual

API Function Descriptions RscErrorInfo [RSCERI]
RscErrorInfo [RSCERI]
The RscErrorInfo function provides detailed information about error codes returned by
other RSC/MP API functions. Specifying NULL for a parameter to this function means
that the application does no t receive the corresponding information. Applications can
use the RscErrorInfo return va lue to determine what corrective action to take.
USHORT RscErrorInfo
(USHORT uErrorCode /* in */
,USHORT *puSubsystem /* out */
,USHORT *puError /* out */
,USHORT *puExtendedError /* out */
,CHAR *pcErrorText /* out */
,USHORT *puTextLength /* in / out */
);
uErrorCode
The error code returned from an RSC/MP API function call.
puSubsystem
If not NULL, is the pointer to the location to receive the subsystem from which the
error originated. The subsystem identifiers are defined in the RSC.H file as
RSC_*_SUBSYSTEM, where * represents the subsystem na me.
puError
If not NULL, is the pointer to the location to receive the error va lue that the
subsystem reports.
puExtendedError
If not NULL, the pointer to the location to receive any extended error that the
subsystem reports. This value can be returned only if RscErrorInfo is called after
the RSC/MP API function that returned the error and before any other RSC/MP
API function. If this is the only information being retrieved (that is, if puSubsystem,
puError, pcErrorText, and puTextLength are all NULL), no read attempt is made on
the RSC.ERR file
pcErrorText
If not NULL, is the pointer to the location to receive text describing the error. This
parameter should point to a character buffer of the size stored in the integer
pointed to by puTextLength, which must be at least 32 bytes long. The error text is
truncated if the buffer is too short. The maximum length of any message is 256
bytes.
HP NonStop Remote Server Call (RSC/MP) Programming Manual — 522360-006
10 - 13