Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

tt_pattern_disposition_add (3)

Name

tt_pattern_disposition_add - add a value to the disposition field for a pattern

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_pattern_disposition_add(Tt_pattern p,
Tt_disposition r);

Description

ToolTalk Functions                               tt_pattern_disposition_add(3)



NAME
       tt_pattern_disposition_add - add a value to the disposition field for a
       pattern

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_pattern_disposition_add(Tt_pattern p,
                                            Tt_disposition r);

DESCRIPTION
       The tt_pattern_disposition_add() function adds a value to the  disposi-
       tion field for the specified pattern.

       The  p  argument is a unique handle for a message pattern.  This handle
       is returned after tt_pattern_create(3) is called.

       The r argument indicates whether an instance of the receiver is  to  be
       started  to  receive the message immediately, or whether the message is
       to be queued until the receiving process is started at a later time  or
       discarded  if  the  receiver  is not started.  The following values are
       defined:

          TT_DISCARD
                  There is no receiver for this message.  The message will  be
                  returned  to  the sender with the Tt_status field containing
                  TT_FAILED.

          TT_QUEUE
                  Queue the message  until  a  process  of  the  proper  ptype
                  receives the message.

          TT_START
                  Attempt  to  start  a process of the proper ptype if none is
                  running.

          TT_QUEUE+TT_START
                  Queue the message and attempt to  start  a  process  of  the
                  proper ptype if none is running.

RETURN VALUE
       Upon  successful  completion, the tt_pattern_disposition_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_create(3).




ToolTalk 1.3                     1 March 1996
                                                 tt_pattern_disposition_add(3)