Passes error text with formatted ASCII output to programs for
    processing.

1  –  Format

    sql_get_error_text (buf, len, errmsglen)

2  –  Returns

    The status code that results from the copy operation of the
    vector's text to the user's buffer.

3  –  Arguments

3.1  –  buf

    The buffer declared to receive the text.

    Value:         Address of the buffer declared to receive the text
    Data type:     Character string
    Passing        By reference
    mechanism:

3.2  –  len

    The length of the buffer declared to receive the text.

    Value:         The length of the character string pointed to by
                   the first parameter
    Data type:     Longword
    Passing        By value
    mechanism:

3.3  –  errmsglen

    The number of characters allotted for the error messages to be
    returned.

    Value:         Number of characters allotted for the error
                   messages
    Data type:     Longword
    Passing        By reference
    mechanism:

4  –  Description

    Use the sql_get_error_text routine when you want to pass error
    text with formatted ASCII output (FAO) substitutions to your
    program for processing.

    To use the sql_get_error_text routine, you must include a buffer
    (field) in your program declarations to receive the text SQL will
    pass to it. Declare this field as a text string with a length
    sufficient to accommodate the number of characters you expect for
    the message associated with the RDB$LU_STATUS value and for all
    follow-on messages.

5  –  Related Routines

    o  sql$get_error_text