Brief Index      Full Index      Events Index      I.M. Reference

Generate_Error


Functions

void Generate_Error (int level, int category, int specific, const char *buf1, const char *buf2, const char *buf3)

Function Documentation

void Generate_Error ( int  level,
int  category,
int  specific,
const char *  buf1,
const char *  buf2,
const char *  buf3 
)

Injects an error into HOOPS 3DF.

Parameters:
level - Severity of the error. See details.
category - A numeric code identifying the general categorythe error belongs to.
specific - A numeric code uniquely identifying the specificerror.
buf1 - The first part of the error message. See detailsone line per string. Passed by reference in all languages.
buf2 - The second part of the error message. See detailsone line per string. Passed by reference in all languages.
buf3 - The third part of the error message. See detailsone line per string. Passed by reference in all languages.

DETAILS

Use Generate_Error() to inject an error into the system. The level identifies the severity of the error. The range of legal values are:

  • 0 : info.
  • 1 : warning.
  • 2 : error.
  • 3 : fatal error.

The error message is passed via the buf parameters. If your error message has multiple lines, pass one line per parameter. For instance, if your message has one line, only pass a string for buf1. On the other hand, if your message has two lines, pass the first line as a string for buf1 and the second line as a string for buf2.

See also:
Report_Error, Define_System_Options.

Brief Index      Full Index      Events Index      I.M. Reference