Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_message_arg_val (3)

Name

tt_message_arg_val - ment

Synopsis

#include <Tt/tt_c.h>
char *tt_message_arg_val(Tt_message m,
int n);

Description

tt_message_arg_val(3)         ToolTalk Functions         tt_message_arg_val(3)



NAME
       tt_message_arg_val  -  return a pointer to the value of a message argu-
       ment

SYNOPSIS
       #include <Tt/tt_c.h>
       char *tt_message_arg_val(Tt_message m,
                                int n);

DESCRIPTION
       The tt_message_arg_val() function returns a pointer to the 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
       returned.  The first argument is numbered zero.

RETURN VALUE
       Upon  successful  completion, the tt_message_arg_val() function returns
       the contents  for  the  message  argument.   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_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).

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

APPLICATION USAGE
       The application can 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_ptr_error(3), tt_free(3).




ToolTalk 1.3                     1 March 1996            tt_message_arg_val(3)