<!-- $XConsortium: scope_s.sgm /main/5 1996/08/30 13:43:16 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN143.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN143.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_scope_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_scope_set</Function></RefName>
<RefPurpose>set the scope attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: scope_s.sgm /main/5 1996/08/30 13:43:16 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_scope_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_scope <Parameter>s</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_scope_set</Function> function
sets the scope attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">s</Symbol> argument identifies the set of processes eligible to receive the message.
The following values are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_SESSION</Term>
<ListItem>
<Para>All processes joined to the indicated session are eligible.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_FILE</Term>
<ListItem>
<Para>All processes joined to the indicated file are eligible.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_BOTH</Term>
<ListItem>
<Para>All processes joined to either indicated file
or the indicated session are eligible.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_FILE_IN_SESSION</Term>
<ListItem>
<Para>All processes joined to both the indicated file
and the indicated session are eligible.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_scope_set</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The pointer passed does not point to an object of
the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
