Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_message_arg_ival (3)

Name

tt_message_arg_ival - retrieve the integer value of a message argument

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_message_arg_ival(Tt_message m,
int n,
int *value);

Description

tt_message_arg_ival(3)        ToolTalk Functions        tt_message_arg_ival(3)



NAME
       tt_message_arg_ival - retrieve the integer value of a message argument

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_message_arg_ival(Tt_message m,
                                     int n,
                                     int *value);

DESCRIPTION
       The  tt_message_arg_ival()  function retrieves the integer value of the
       nth message argument.

       The m argument is the opaque handle for the message  involved  in  this
       operation.   The  n  argument  is  the  number  of  the  argument to be
       retrieved.  The first argument is numbered zero.  The value argument is
       a pointer to an integer where the ToolTalk service is to store the con-
       tents of the argument.

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

          TT_OK   The operation completed successfully.

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

          TT_ERR_NUM
                  The integer value passed was invalid (out of range), or,  if
                  the  value  in the message is not yet set (as it would be in
                  observing a request in state TT_SENT and trying to  look  at
                  the TT_OUT arguments).

          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).




ToolTalk 1.3                     1 March 1996           tt_message_arg_ival(3)