Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_pattern_arg_add (3)

Name

tt_pattern_arg_add - add an argument to a pattern

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_pattern_arg_add(Tt_pattern p,
Tt_mode n,
const char *vtype,
const char *value);

Description

tt_pattern_arg_add(3)         ToolTalk Functions         tt_pattern_arg_add(3)



NAME
       tt_pattern_arg_add - add an argument to a pattern

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_pattern_arg_add(Tt_pattern p,
                                    Tt_mode n,
                                    const char *vtype,
                                    const char *value);

DESCRIPTION
       The  tt_pattern_arg_add()  function adds an argument to a pattern.  The
       application must add pattern arguments before it registers the  pattern
       with the ToolTalk service.

       The  p  argument  is the opaque handle for the pattern 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  type  ALL  matches any argument value type.  The value argument is
       the value to fill in.  This value must be an unsigned character string.
       A NULL matches any value.

       Pattern  arguments  are positional paramaters, and thus will only match
       an incoming message if the arguments have the same  type  and  position
       within  the argument list of the incoming message. In order to match an
       argument which is not the first in a list of arguments, the  programmer
       must  use  tt_pattern_arg_add(3) to register wildcard arguments for the
       intervening arguments between the first argument and the argument which
       it  is desired to match on. Wildcard arguments should have the vtype of
       "ALL" and a value of NULL.

RETURN VALUE
       Upon successful completion, the tt_pattern_arg_add()  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_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_pattern_register(3), tt_pattern_barg_add(3), tt_pat-
       tern_iarg_add(3).




ToolTalk 1.3                     1 March 1996            tt_pattern_arg_add(3)