ProviewR Programmer's Reference Manual  V6.1.4
Functions

Functions

pwr_tStatus errh_Init (const char *programName, errh_eAnix anix)
 Initialize errh. Set up a queue to write to, set application name. More...
 
void errh_SetStatus (pwr_tStatus sts)
 Set application status. The application status is showed in the Node graph. The application can set this status with a call to errh_SetStatus. The status should be defined in the message file. More...
 
void errh_Fatal (const char *msg,...)
 Log a fatal message. The function has a variable argument list similar to sprintf. More...
 
void errh_Error (const char *msg,...)
 Log an error message. The function has a variable argument list similar to sprintf. More...
 
void errh_Warning (const char *msg,...)
 Log a warning message. The function has a variable argument list similar to sprintf. More...
 
void errh_Info (const char *msg,...)
 Log an info message. The function has a variable argument list similar to sprintf. More...
 
void errh_Success (const char *msg,...)
 Log a success message. The function has a variable argument list similar to sprintf. More...
 
errh_eAnix errh_Anix (void)
 Get application index for the process. More...
 
void errh_SetAnix (errh_eAnix anix)
 Set application index for the process.
 
void errh_SetName (char *name)
 Set application name for the process.
 

Detailed Description

Function Documentation

◆ errh_Anix()

errh_eAnix errh_Anix ( void  )

Get application index for the process.

Returns
Application index.

Definition at line 212 of file rt_errh.c.

Referenced by aproc_RegisterObject(), and aproc_TimeStamp().

◆ errh_Error()

void errh_Error ( const char *  msg,
  ... 
)

Log an error message. The function has a variable argument list similar to sprintf.

Parameters
msgString with message to log. The string can contain format specifiers.

Example

errh_Error("Configuration error");

Definition at line 343 of file rt_errh.c.

◆ errh_Fatal()

void errh_Fatal ( const char *  msg,
  ... 
)

Log a fatal message. The function has a variable argument list similar to sprintf.

Parameters
msgString with message to log. The string can contain format specifiers.

Example

errh_Fatal("Process terminated, %m", sts);

Definition at line 364 of file rt_errh.c.

◆ errh_Info()

void errh_Info ( const char *  msg,
  ... 
)

Log an info message. The function has a variable argument list similar to sprintf.

Parameters
msgString with message to log. The string can contain format specifiers.

Example

errh_Info("Reset count %d", cnt);

Definition at line 301 of file rt_errh.c.

◆ errh_Init()

pwr_tStatus errh_Init ( const char *  name,
errh_eAnix  anix 
)

Initialize errh. Set up a queue to write to, set application name.

Parameters
nameName of application. This name is written in the logging entry to identify the process.
anixApplication index. Applications should choose a index in the range errh_eAnix_appl1 - errh_eAnix_appl20.
Returns
Status or operation.

Definition at line 178 of file rt_errh.c.

◆ errh_SetStatus()

void errh_SetStatus ( pwr_tStatus  sts)

Set application status. The application status is showed in the Node graph. The application can set this status with a call to errh_SetStatus. The status should be defined in the message file.

Parameters
stsNew application status.

Definition at line 202 of file rt_errh.c.

◆ errh_Success()

void errh_Success ( const char *  msg,
  ... 
)

Log a success message. The function has a variable argument list similar to sprintf.

Parameters
msgString with message to log. The string can contain format specifiers.

Example

errh_Success("Process initialized");

Definition at line 280 of file rt_errh.c.

◆ errh_Warning()

void errh_Warning ( const char *  msg,
  ... 
)

Log a warning message. The function has a variable argument list similar to sprintf.

Parameters
msgString with message to log. The string can contain format specifiers.

Example

errh_Warning("Connection lost to %s", name);

Definition at line 322 of file rt_errh.c.