Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tt_message_iarg_add (3)

Name

tt_message_iarg_add - add a new argument to a message object

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_message_iarg_add(Tt_message m,
Tt_mode n,
const char *vtype,
int value);

Description

tt_message_iarg_add(3)        ToolTalk Functions        tt_message_iarg_add(3)



NAME
       tt_message_iarg_add - add a new argument to a message object

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_message_iarg_add(Tt_message m,
                                     Tt_mode n,
                                     const char *vtype,
                                     int value);

DESCRIPTION
       The  tt_message_iarg_add()  function  adds  a new argument to a message
       object and sets the value to a given integer.

       Add all arguments before the message is sent.  To change existing argu-
       ment values, the application must use only modes TT_OUT or TT_INOUT.

       Adding arguments when replying to a message produces undefined results.

       The  m  argument  is the opaque handle for the message involved in this
       operation.  The n argument specifies who (sender,  handler,  observers)
       writes and reads a message argument.  The following modes are defined:

          TT_IN   The  argument  is written by the sender and read by the han-
                  dler and any observers.

          TT_OUT
                  The argument is written by  the  handler  and  read  by  the
                  sender and any reply observers.

          TT_INOUT
                  The  argument  is  written by the sender and the handler and
                  read by all.

       The vtype argument describes the type of  argument  data  being  added.
       The value argument is the value to be added.

RETURN VALUE
       Upon  successful completion, the tt_message_iarg_add() function returns
       the status of the operation as one of the following Tt_status values:

          TT_OK   The operation completed successfully.

          TT_ERR_MODE
                  The specified Tt_mode is invalid.

          TT_ERR_NOMP
                  The ttsession(1) process is not  running  and  the  ToolTalk
                  service cannot restart it.

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

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_message_arg_ival_set(3), tt_message_arg_add(3), tt_mes-
       sage_barg_add(3).




ToolTalk 1.3                     1 March 1996           tt_message_iarg_add(3)