Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Latest commit

 

History

History
38 lines (26 loc) · 1.02 KB

Fault.md

File metadata and controls

38 lines (26 loc) · 1.02 KB
Raw

NAME

Fault -- Returns the text associated with a DOS error code (V36)

SYNOPSIS

    success = Fault(code, header, buffer, len)
    D0               D1     D2      D3    D4

    BOOL Fault(LONG, STRPTR, STRPTR, LONG)

FUNCTION

This routine obtains the error message text for the given error code. The header is prepended to the text of the error message, followed by a colon. Puts a null-terminated string for the error message into the buffer. By convention, error messages should be no longer than 80 characters (+1 for termination), and preferably no more than 60. The value returned by IoErr is set to the code passed in. If there is no message for the error code, the message will be "Error code <number>n".

INPUTS

code - Error code header - header to output before error text buffer - Buffer to receive error message. len - Length of the buffer.

RESULT success - Success/failure code.

SEE ALSO

IoErr, SetIoErr, PrintFault