Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

tt_message_scope_set (3)

Name

tt_message_scope_set - set the scope attribute for a message

Synopsis

#include <Tt/tt_c.h>
Tt_status tt_message_scope_set(Tt_message m,
Tt_scope s);

Description

tt_message_scope_set(3)       ToolTalk Functions       tt_message_scope_set(3)



NAME
       tt_message_scope_set - set the scope attribute for a message

SYNOPSIS
       #include <Tt/tt_c.h>
       Tt_status tt_message_scope_set(Tt_message m,
                                      Tt_scope s);

DESCRIPTION
       The  tt_message_scope_set()  function  sets the scope attribute for the
       specified message.

       The m argument is the opaque handle for the message  involved  in  this
       operation.   The s argument identifies the set of processes eligible to
       receive the message.  The following values are defined:

          TT_SESSION
                  All processes joined to the indicated session are eligible.

          TT_FILE
                  All processes joined to the indicated file are eligible.

          TT_BOTH
                  All processes joined to either indicated file or  the  indi-
                  cated session are eligible.

          TT_FILE_IN_SESSION
                  All  processes  joined  to  both  the indicated file and the
                  indicated session are eligible.

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




ToolTalk 1.3                     1 March 1996          tt_message_scope_set(3)