HPlogo Using KSAM XL and KSAM 64 > Chapter 9 KSAM Intrinsics

FERRMSG

MPE documents

Complete PDF
Table of Contents
Index

E0300 Edition 4 ♥
E0394 Edition 3

Syntax Parameters Operation Notes Condition Codes

Returns a message corresponding to an FCHECK error number and enables error messages to be displayed from a program.

Syntax



           I16          CA         I16
  FERRMSG (fserrorcode, msgbuffer, msglength);

Parameters


fserrorcode

16-bit signed integer by reference (required)

Passes an error code returned by the FCHECK intrinsic, indicating which message to return in msgbuffer.

msgbuffer

character array (required)

Returns the error message identified with fserrorcode. To contain the longest possible message, msgbuffer must be >= 72 bytes long.

msglength

16-bit signed integer by reference (required)

Returns the length of the error message in msgbuffer. The length is returned in positive bytes.

Operation Notes


None.

Condition Codes


CCE

Request granted.

CCG

Request denied. No error message exists for this fserrorcode.

CCL

Request denied. The msgbuffer address was out of bounds, msgbuffer was not large enough, or msglength was out of bounds.

Refer to this intrinsic in the MPE/iX Intrinsics Reference Manual for other codes pertaining to KSAM files.




FCONTROL


FFILEINFO