Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tt_error (3)

Name

tt_error - Interpose a function to detect errors returned from the ToolTalk API.

Synopsis

#include <Tt/tt_c.h>
void tt_error ( const char *funcname, Tt_status status );

Description

tt_error(3)                   ToolTalk Functions                   tt_error(3)



NAME
       tt_error  -  Interpose  a  function  to detect errors returned from the
       ToolTalk API.

SYNOPSIS
       #include <Tt/tt_c.h>
       void tt_error ( const char *funcname, Tt_status status );

DESCRIPTION
       The tt_error() function is a publicly-known null function.  This  func-
       tions is called by the ToolTalk library just before it returns from any
       ToolTalk API call that has a status other than TT_OK. The name  of  the
       function that is about to return and the status code is passed.

       You  can  use  this call to set a dbx breakpoint in tt_error to quickly
       catch and trace back any ToolTalk errors. You can also  interpose  this
       function, for example, to log ToolTalk errors to stderr.

APPLICATION USAGE
       The  following  code  example  shows how an application might interpose
       this function to log ToolTalk errors to stderr

                 void tt_error(const char *funcname, Tt_status status) {
                      fprintf(stderr, "ToolTalk function %s returned %s.\n",
                           funcname, tt_status_message(status));
                 }

ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+

SEE ALSO
       tt_c(5)




ToolTalk 1.3                     1 March 1996                      tt_error(3)