Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_message_print (3)

Name

tt_message_print - format a message

Synopsis

#include <Tt/tt_c.h>
char *tt_message_print(Tt_message m);

Description

tt_message_print(3)           ToolTalk Functions           tt_message_print(3)



NAME
       tt_message_print - format a message

SYNOPSIS
       #include <Tt/tt_c.h>
       char *tt_message_print(Tt_message m);

DESCRIPTION
       The  tt_message_print()  function  formats  a message in the same way a
       message is formatted for the ttsession(1) trace and  returns  a  string
       containing it.

       The m argument is the message to be formatted.

RETURN VALUE
       Upon successful completion, the tt_message_print() function returns the
       formatted string.  The application can use tt_ptr_error(3)  to  extract
       one of the following Tt_status values from the returned pointer:

          TT_OK   The operation completed successfully.

          TT_ERR_NOMEM
                  There  is insufficient memory available to perform the func-
                  tion.

          TT_ERR_POINTER
                  The pointer passed does not point to an object of  the  cor-
                  rect type for this operation.

APPLICATION USAGE
       The  tt_message_print() function allows an application to dump out mes-
       sages that are received but not understood.

       The application should use tt_free(3) to free any data  stored  in  the
       address returned by the ToolTalk API.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/tooltalk |
       +---------------+------------------+
       |Stability      | Committed        |
       +---------------+------------------+
SEE ALSO
       tt_c(5), tt_free(3), tt_ptr_error(3).




ToolTalk 1.3                     1 March 1996              tt_message_print(3)