debian/cdesktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial import of the CDE 2.1.30 sources from the Open Group.

Browse Source
This commit is contained in:
Peter Howkins
2012-03-10 18:21:40 +00:00
commit 83b6996daa
18978 changed files with 3945623 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
cde/doc/C/guides/man/m3_tt_message/abstai_c.sgm Normal file
View File

@@ -0,0 +1,107 @@
<!-- $XConsortium: abstai_c.sgm /main/3 1996/08/30 13:31:34 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.MAN327.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN327.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_abstainers_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_abstainers_count</Function></RefName>
<RefPurpose>return a count of the offer's abstaining procids
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>tt_message_abstainers_count</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_abstainers_count</Function>
function
returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having abstained from it.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_abstainers_count</Function>
function returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having abstained from it.
The application can use
<Function>tt_int_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned integer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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;,
&cdeman.tt.message.abstainer;,
&cdeman.tt.int.error;.
</Para>
</RefSect1>
</RefEntry>

126
cde/doc/C/guides/man/m3_tt_message/abstain.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: abstain.sgm /main/3 1996/08/30 13:31:47 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.MAN328.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN328.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_abstainer</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_abstainer</Function></RefName>
<RefPurpose>return offer's nth abstaining procid
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char *<Function>tt_message_abstainer</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_abstainer</Function>
function
returns the procid of the
<Symbol Role="Variable">n</Symbol>th
abstainer of the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
The
<Emphasis>n</Emphasis>
argument is the number of the abstainer to be returned.
The first abstainer is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_abstainer</Function>
function returns the procid of the
<Symbol Role="Variable">n</Symbol>th
abstainer.
The application can use
<Function>tt_ptr_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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>APPLICATION USAGE</Title>
<Para>The application can use
<Function>tt_free</Function>
to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.message.abstainers.count;,
&cdeman.tt.ptr.error;,
&cdeman.tt.free;.
</Para>
</RefSect1>
</RefEntry>

100
cde/doc/C/guides/man/m3_tt_message/accept.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: accept.sgm /main/5 1996/08/30 13:31:57 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.MAN87.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN87.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_accept</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_accept</Function></RefName>
<RefPurpose>declare that the process has been initialized and can accept messages
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: accept.sgm /main/5 1996/08/30 13:31:57 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_accept</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_accept</Function> function
declares that the process has been initialized and can accept messages.
</Para>
<Para>The ToolTalk service invokes this function for start messages.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_accept</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_UNIMP</Term>
<ListItem>
<Para>The ToolTalk function called is not implemented.
</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.
<![ %CDE.C.CDE; [</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The message is a
<SystemItem Class="Constant">TT_REQUEST</SystemItem> or
<SystemItem Class="Constant">TT_OFFER</SystemItem> in a final state.
]]></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-->

107
cde/doc/C/guides/man/m3_tt_message/accept_c.sgm Normal file
View File

@@ -0,0 +1,107 @@
<!-- $XConsortium: accept_c.sgm /main/3 1996/08/30 13:32:08 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.MAN329.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN329.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_accepters_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_accepter_count</Function></RefName>
<RefPurpose>return a count of the offer's accepting procids
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>tt_message_accepters_count</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_accepters_count</Function>
function
returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having accepted it.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_accepters_count</Function>
function returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having accepted it.
The application can use
<Function>tt_int_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned integer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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;,
&cdeman.tt.message.accepter;,
&cdeman.tt.int.error;.
</Para>
</RefSect1>
</RefEntry>

126
cde/doc/C/guides/man/m3_tt_message/accepter.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: accepter.sgm /main/3 1996/08/30 13:32:19 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.MAN330.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN330.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_accepter</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_accepter</Function></RefName>
<RefPurpose>return offer's nth accepting procid
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char *<Function>tt_message_accepter</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_accepter</Function>
function
returns the procid of the
<Symbol Role="Variable">n</Symbol>th
accepter of the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
The
<Emphasis>n</Emphasis>
argument is the number of the accepter to be returned.
The first accepter is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_accepter</Function>
function returns the procid of the
<Symbol Role="Variable">n</Symbol>th
accepter.
The application can use
<Function>tt_ptr_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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>APPLICATION USAGE</Title>
<Para>The application can use
<Function>tt_free</Function>
to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.message.accepters.count;,
&cdeman.tt.ptr.error;,
&cdeman.tt.free;.
</Para>
</RefSect1>
</RefEntry>

121
cde/doc/C/guides/man/m3_tt_message/addr_set.sgm Normal file
View File

@@ -0,0 +1,121 @@
<!-- $XConsortium: addr_set.sgm /main/5 1996/08/30 13:32:29 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.MAN89.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN89.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_address_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_address_set</Function></RefName>
<RefPurpose>set the address attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: addr_set.sgm /main/5 1996/08/30 13:32:29 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_address_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_address <Parameter>a</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_address_set</Function> function
sets the address 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">a</Symbol> argument specifies which message attributes form the address to
which the message will be delivered.
The following values are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_HANDLER</Term>
<ListItem>
<Para>The message is addressed to a specific handler
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OBJECT</Term>
<ListItem>
<Para>The message is addressed to a specific object
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OTYPE</Term>
<ListItem>
<Para>The message is addressed to the type of object
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_PROCEDURE</Term>
<ListItem>
<Para>The message is addressed to any process
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_address_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-->

123
cde/doc/C/guides/man/m3_tt_message/address.sgm Normal file
View File

@@ -0,0 +1,123 @@
<!-- $XConsortium: address.sgm /main/5 1996/08/30 13:32:39 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.MAN88.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN88.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_address</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_address</Function></RefName>
<RefPurpose>retrieve the address attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: address.sgm /main/5 1996/08/30 13:32:39 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_address <Function>tt_message_address</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_address</Function> function
retrieves the address attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_address</Function> function returns a value that specifies which message attributes
form the address of this message.
The
<Function>tt_message_address</Function> function returns one of the following
<StructName Role="typedef">Tt_address</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_HANDLER</Term>
<ListItem>
<Para>The message is addressed to a specific handler
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OBJECT</Term>
<ListItem>
<Para>The message is addressed to a specific object
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OTYPE</Term>
<ListItem>
<Para>The message is addressed to the type of object
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_PROCEDURE</Term>
<ListItem>
<Para>The message is addressed to any process
that can perform this operation with these arguments.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

142
cde/doc/C/guides/man/m3_tt_message/arg_add.sgm Normal file
View File

@@ -0,0 +1,142 @@
<!-- $XConsortium: arg_add.sgm /main/7 1996/09/08 20:23:31 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.MAN90.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN90.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_add</Function></RefName>
<RefPurpose>add a new argument to a message object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_add.sgm /main/7 1996/09/08 20:23:31 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_arg_add</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_mode <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vtype</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_add</Function> function
adds a new argument to a message object.
</Para>
<Para>The application must add all arguments before the message is sent.
To change existing argument values, the application must use only modes
<SystemItem Class="Constant">TT_OUT</SystemItem> or
<SystemItem Class="Constant">TT_INOUT</SystemItem>.</Para>
<Para>Adding arguments when replying to a message
produces undefined results.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument specifies who (sender, handler, observers)
writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>vtype</Emphasis> argument describes the type of argument data being added.
The
<Symbol Role="Variable">value</Symbol> argument is the contents for the message argument attribute.
The application can use
<SystemItem Class="Constant">NULL</SystemItem> either for values of mode
<SystemItem Class="Constant">TT_OUT</SystemItem>, or if the value is to be filled in later with one of the following:
</Para>
<InformalExample Remap="indent">
<ProgramListing><Function>tt_message_arg_val_set</Function>
<Function>tt_message_iarg_val_set</Function></ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_add</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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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;, &cdeman.tt.message.arg.val.set;, &cdeman.tt.message.barg.add;, &cdeman.tt.message.iarg.add;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

109
cde/doc/C/guides/man/m3_tt_message/arg_bv_s.sgm Normal file
View File

@@ -0,0 +1,109 @@
<!-- $XConsortium: arg_bv_s.sgm /main/5 1996/08/30 13:32:59 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.MAN92.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN92.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_bval_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_bval_set</Function></RefName>
<RefPurpose>set the byte-array value and type of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_bv_s.sgm /main/5 1996/08/30 13:32:59 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_arg_bval_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>const unsigned char *<Parameter>value</Parameter></ParamDef>
<ParamDef>int <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_bval_set</Function> function
sets the byte-array value and the type of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>This function also changes the value of an existing
<Symbol Role="Variable">n</Symbol>th message argument to a byte string.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to set.
The first argument is numbered zero.
The
<Symbol Role="Variable">value</Symbol> argument is the byte string with the contents for the message argument.
The
<Emphasis>len</Emphasis> argument is the length of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_bval_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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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>APPLICATION USAGE</Title>
<Para>The sending process can use
&cdeman.tt.message.arg.bval.set; to fill in opaque data.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.barg.add;, &cdeman.tt.message.arg.val.set;, &cdeman.tt.message.arg.ival.set;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

103
cde/doc/C/guides/man/m3_tt_message/arg_bval.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: arg_bval.sgm /main/5 1996/08/30 13:33:10 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.MAN91.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN91.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_bval</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_bval</Function></RefName>
<RefPurpose>retrieve the byte-array value of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_bval.sgm /main/5 1996/08/30 13:33:10 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_arg_bval</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>unsigned char **<Parameter>value</Parameter></ParamDef>
<ParamDef>int *<Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_bval</Function> function
retrieves the byte-array value of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be retrieved.
The first argument is numbered zero.
The
<Symbol Role="Variable">value</Symbol> argument is the
address of a character pointer to which the ToolTalk service
is to point a string that contains the contents of the argument.
The
<Emphasis>len</Emphasis> argument is the address of an integer to which the ToolTalk service
is to set the length of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_bval</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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-->

99
cde/doc/C/guides/man/m3_tt_message/arg_iv_s.sgm Normal file
View File

@@ -0,0 +1,99 @@
<!-- $XConsortium: arg_iv_s.sgm /main/5 1996/08/30 13:33:20 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.MAN94.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN94.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_ival_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_ival_set</Function></RefName>
<RefPurpose>add an integer value in a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_iv_s.sgm /main/5 1996/08/30 13:33:20 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_arg_ival_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>int <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_ival_set</Function> function adds an integer value in the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>This function also changes the value of an existing
<Symbol Role="Variable">n</Symbol>th message argument to an integer.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be set.
The first argument is numbered zero.
The
<Symbol Role="Variable">value</Symbol> argument is the contents for the message argument.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_ival_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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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;, &cdeman.tt.message.iarg.add;, &cdeman.tt.message.arg.val.set;, &cdeman.tt.message.arg.bval.set;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

98
cde/doc/C/guides/man/m3_tt_message/arg_ival.sgm Normal file
View File

@@ -0,0 +1,98 @@
<!-- $XConsortium: arg_ival.sgm /main/5 1996/08/30 13:33:30 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.MAN93.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN93.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_ival</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_ival</Function></RefName>
<RefPurpose>retrieve the integer value of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_ival.sgm /main/5 1996/08/30 13:33:30 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_arg_ival</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>int *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_ival</Function> function
retrieves the integer value of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be retrieved.
The first argument is numbered zero.
The
<Symbol Role="Variable">value</Symbol> argument is a pointer to an integer where the ToolTalk service
is to store the contents of the argument.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_ival</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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-->

126
cde/doc/C/guides/man/m3_tt_message/arg_mode.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: arg_mode.sgm /main/5 1996/08/30 13:33:41 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.MAN95.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN95.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_mode</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_mode</Function></RefName>
<RefPurpose>return the mode of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_mode.sgm /main/5 1996/08/30 13:33:41 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_mode <Function>tt_message_arg_mode</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_mode</Function> function
returns the mode of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be returned.
The first argument is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_mode</Function> function returns a value that specifies who
(sender, handler, observers) writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_mode</StructName> integer return value:
</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

104
cde/doc/C/guides/man/m3_tt_message/arg_type.sgm Normal file
View File

@@ -0,0 +1,104 @@
<!-- $XConsortium: arg_type.sgm /main/5 1996/08/30 13:33:54 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.MAN96.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN96.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_type</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_type</Function></RefName>
<RefPurpose>retrieve the type of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_type.sgm /main/5 1996/08/30 13:33:54 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>char <Function>*tt_message_arg_type</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_type</Function> function
retrieves the type of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be retrieved.
The first argument is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_type</Function> function returns the type of the
<Symbol Role="Variable">n</Symbol>th message argument.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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>APPLICATION USAGE</Title>
<Para>The application can use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

97
cde/doc/C/guides/man/m3_tt_message/arg_va_s.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: arg_va_s.sgm /main/5 1996/08/30 13:34:04 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.MAN98.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN98.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_val_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_val_set</Function></RefName>
<RefPurpose>change the value of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_va_s.sgm /main/5 1996/08/30 13:34:04 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_arg_val_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_val_set</Function> function
changes the value of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be changed.
The first argument is numbered zero.
The
<Symbol Role="Variable">value</Symbol> argument is the contents for the message argument.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_val_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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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-->

103
cde/doc/C/guides/man/m3_tt_message/arg_val.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: arg_val.sgm /main/5 1996/08/30 13:34:18 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.MAN97.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN97.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_val</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_val</Function></RefName>
<RefPurpose>return a pointer to the value of a message argument
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: arg_val.sgm /main/5 1996/08/30 13:34:18 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>char <Function>*tt_message_arg_val</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_val</Function> function
returns a pointer to the value of the
<Symbol Role="Variable">n</Symbol>th message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be returned.
The first argument is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_val</Function> function returns the contents for the message argument.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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>APPLICATION USAGE</Title>
<Para>The application can use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

112
cde/doc/C/guides/man/m3_tt_message/arg_xv_s.sgm Normal file
View File

@@ -0,0 +1,112 @@
<!-- $XConsortium: arg_xv_s.sgm /main/7 1996/08/30 13:34:30 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.MAN100.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN100.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_xval_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_xval_set</Function></RefName>
<RefPurpose>serialize and set data into an existing message argument
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_arg_xval_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>xdrproc_t <Parameter>xdr_proc</Parameter></ParamDef>
<ParamDef>void *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_xval_set</Function> function
serializes and sets data into an existing message argument.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be changed.
The first argument is numbered zero.
The
<Emphasis>xdr_proc</Emphasis> argument causes
<Function>tt_message_arg_xval_set</Function> to serialize the data pointed to by
<Symbol Role="Variable">value</Symbol> and store it as a byte string value of the
<Symbol Role="Variable">n</Symbol>th argument of the message.
The
<Symbol Role="Variable">value</Symbol> argument is the data to be serialized.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_xval_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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_XDR</Term>
<ListItem>
<Para>The XDR procedure failed on the given data, or evaluated to a
zero-length expression.
</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-->

123
cde/doc/C/guides/man/m3_tt_message/arg_xval.sgm Normal file
View File

@@ -0,0 +1,123 @@
<!-- $XConsortium: arg_xval.sgm /main/7 1996/08/30 13:34:41 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.MAN99.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN99.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_arg_xval</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_arg_xval</Function></RefName>
<RefPurpose>retrieve and deserialize the data from a message argument
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_arg_xval</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
<ParamDef>xdrproc_t <Parameter>xdr_proc</Parameter></ParamDef>
<ParamDef>void **<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_arg_xval</Function> function
retrieves and deserializes the data from a message argument.
This function uses an XDR routine that is supplied by the client.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the argument to be returned.
The first argument is numbered zero.
The
<Emphasis>xdr_proc</Emphasis> argument
points to the XDR procedure to be used to deserialize the data in the
<Symbol Role="Variable">n</Symbol>th argument into newly allocated storage,
the address of which will be stored in the pointer whose address is
<Symbol Role="Variable">value</Symbol>.</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument is the data to be deserialized.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_arg_xval</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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_XDR</Term>
<ListItem>
<Para>The XDR procedure failed on the given data, or evaluated to a
zero-length structure.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The allocation calls are made by the XDR procedure; therefore, any
storage allocated is not allocated from the ToolTalk allocation stack.
The application should
use the
<Function>xdr_free</Function>(3) call to free this storage.
</Para>
</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-->

84
cde/doc/C/guides/man/m3_tt_message/args_cnt.sgm Normal file
View File

@@ -0,0 +1,84 @@
<!-- $XConsortium: args_cnt.sgm /main/5 1996/08/30 13:34:54 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.MAN101.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN101.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_args_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_args_count</Function></RefName>
<RefPurpose>return the number of arguments in the message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: args_cnt.sgm /main/5 1996/08/30 13:34:54 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>int <Function>tt_message_args_count</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_args_count</Function> function
returns the number of arguments in the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_args_count</Function> function returns the total number of arguments in the message.
The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

128
cde/doc/C/guides/man/m3_tt_message/barg_add.sgm Normal file
View File

@@ -0,0 +1,128 @@
<!-- $XConsortium: barg_add.sgm /main/8 1996/08/30 13:35:04 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.MAN102.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN102.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_barg_add</RefEntryTitle><ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_barg_add</Function></RefName>
<RefPurpose>add an argument to a pattern
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_barg_add</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_mode <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vtype</Parameter></ParamDef>
<ParamDef>const unsigned char *<Parameter>value</Parameter></ParamDef>
<ParamDef>int <Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_barg_add</Function> function
adds an argument to a pattern that may have a byte-array value that
contains embedded nulls.
</Para>
<Para>To change existing argument values, the application must use only modes
<SystemItem Class="Constant">TT_OUT</SystemItem> or
<SystemItem Class="Constant">TT_INOUT</SystemItem>.</Para>
<Para>Adding arguments when replying to a message produces undefined results.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument specifies who (sender, handler, observers)
writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>vtype</Emphasis> argument describes the type of argument data being added.
</Para>
<Para>The ToolTalk service treats the value as an opaque byte string.
To pass structured data, the application and the receiving application
must encode and decode these opaque byte strings.
The most common method to do this is XDR.
</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument is the value to be added.
The
<Emphasis>len</Emphasis> argument is the length of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_barg_add</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;, &cdeman.tt.message.arg.add;, &cdeman.tt.message.iarg.add;
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

100
cde/doc/C/guides/man/m3_tt_message/bcon_set.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: bcon_set.sgm /main/5 1996/08/30 13:35:15 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.MAN103.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN103.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_bcontext_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_bcontext_set</Function></RefName>
<RefPurpose>set the byte-array value of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bcon_set.sgm /main/5 1996/08/30 13:35:15 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_bcontext_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>const unsigned char *<Parameter>value</Parameter></ParamDef>
<ParamDef>int <Parameter>length</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_bcontext_set</Function> function
sets the byte-array value of a message's context.
</Para>
<Para>This function overwrites any previous value associated with
<Emphasis>slotname</Emphasis>.</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the slotname in this message.
The
<Symbol Role="Variable">value</Symbol> argument is the byte string with the contents for the message argument.
The
<Symbol Role="Variable">length</Symbol> argument is the length of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_bcontext_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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</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-->

117
cde/doc/C/guides/man/m3_tt_message/call_add.sgm Normal file
View File

@@ -0,0 +1,117 @@
<!-- $XConsortium: call_add.sgm /main/5 1996/08/30 13:35:25 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.MAN104.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN104.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_callback_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_callback_add</Function></RefName>
<RefPurpose>register a callback function
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: call_add.sgm /main/5 1996/08/30 13:35:25 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_callback_add</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_message_callback <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_callback_add</Function> function
registers a callback function to be automatically invoked by
&cdeman.tt.message.receive; whenever a reply or other state-change to this message is returned.
</Para>
<Para>The callback is defined in
&cdeman.Tt.tt.c.h;. If the callback returns
<SystemItem Class="Constant">TT_CALLBACK_CONTINUE</SystemItem>, other callbacks will be
run; if no callback returns
<SystemItem Class="Constant">TT_CALLBACK_PROCESSED</SystemItem>, <Function>tt_message_receive</Function> returns the message.
If the callback returns
<SystemItem Class="Constant">TT_CALLBACK_PROCESSED</SystemItem>, no further callbacks are
invoked for this event;
<Function>tt_message_receive</Function> does not return the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>f</Emphasis> argument is the message callback to be run.
</Para>
<Para>The pattern handle will be
<SystemItem Class="Constant">NULL</SystemItem> if the message did not match a dynamic pattern.
This is usually the case for message callbacks.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_callback_add</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>APPLICATION USAGE</Title>
<Para>These callbacks are invoked from
<Function>tt_message_receive</Function>; the program must, therefore, call
<Function>tt_message_receive</Function> when the file descriptor returned by
<Function>tt_fd</Function> becomes active.
</Para>
<Para>The application can use
<Function>tt_message_callback_add</Function> to create wrappers for ToolTalk messages.
For example, a library routine can construct a request,
attach a callback to the message, send
the message, and process the reply in the callback.
When the callback returns
<SystemItem Class="Constant">TT_CALLBACK_PROCESSED</SystemItem>, the message reply is not returned to the main
program; the message and reply are, therefore, completely hidden.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.receive;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

109
cde/doc/C/guides/man/m3_tt_message/class.sgm Normal file
View File

@@ -0,0 +1,109 @@
<!-- $XConsortium: class.sgm /main/5 1996/08/30 13:35:35 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.MAN105.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN105.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_class</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_class</Function></RefName>
<RefPurpose>retrieve the class attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: class.sgm /main/5 1996/08/30 13:35:35 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_class <Function>tt_message_class</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_class</Function> function
retrieves the class attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_class</Function> function returns a value that indicates whether the sender
wants an action to take place after the message is received.
The
<Function>tt_message_class</Function> function returns one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_NOTICE</Term>
<ListItem>
<Para>A notice of an event.
The sender does not want feedback on this message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_REQUEST</Term>
<ListItem>
<Para>A request for some action to be taken.
The sender must be notified of progress,
success or failure, and must receive any return values.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_class</StructName> integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

106
cde/doc/C/guides/man/m3_tt_message/class_s.sgm Normal file
View File

@@ -0,0 +1,106 @@
<!-- $XConsortium: class_s.sgm /main/5 1996/08/30 13:35:46 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.MAN106.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN106.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_class_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_class_set</Function></RefName>
<RefPurpose>set the class attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: class_s.sgm /main/5 1996/08/30 13:35:46 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_class_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_class <Parameter>c</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_class_set</Function> function
sets the class attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>c</Emphasis> argument indicates whether an action is to take place after the
message is received.
The following values are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_NOTICE</Term>
<ListItem>
<Para>A notice of an event.
The sender does not want feedback on this message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_REQUEST</Term>
<ListItem>
<Para>A request for some action to be taken.
The sender must be notified of progress,
success or failure, and must receive any return values.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_class_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-->

103
cde/doc/C/guides/man/m3_tt_message/con_bval.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: con_bval.sgm /main/5 1996/08/30 13:35:57 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.MAN107.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN107.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_bval</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_bval</Function></RefName>
<RefPurpose>retrieve the byte-array value and length of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_bval.sgm /main/5 1996/08/30 13:35:57 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_context_bval</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>unsigned char **<Parameter>value</Parameter></ParamDef>
<ParamDef>int *<Parameter>len</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_bval</Function> function
retrieves the byte-array value and length of a message's context.
</Para>
<Para>If there is no context slot associated with
<Emphasis>slotname</Emphasis>, <Function>tt_message_context_bval</Function> returns
zero in
<Emphasis>slotname</Emphasis> and zero in
<Emphasis>len</Emphasis>.</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
The
<Symbol Role="Variable">value</Symbol> argument points to the location to return the value.
The
<Emphasis>len</Emphasis> argument is the length of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_bval</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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</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-->

120
cde/doc/C/guides/man/m3_tt_message/con_ival.sgm Normal file
View File

@@ -0,0 +1,120 @@
<!-- $XConsortium: con_ival.sgm /main/5 1996/08/30 13:36:08 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.MAN108.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN108.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_ival</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_ival</Function></RefName>
<RefPurpose>retrieve the integer value of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_ival.sgm /main/5 1996/08/30 13:36:08 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_context_ival</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>int *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_ival</Function> function
retrieves the integer value of a message's context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
The
<Symbol Role="Variable">value</Symbol> argument points to the location to return the value.
</Para>
<Para>If there is no context slot associated with
<Emphasis>slotname</Emphasis>, <Function>tt_message_context_ival</Function> returns a
<SystemItem Class="Constant">NULL</SystemItem> pointer in
<Symbol Role="Variable">*value</Symbol>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_ival</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_WRN_NOTFOUND</Term>
<ListItem>
<Para>The named context does not exist on the specified message.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application can use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

96
cde/doc/C/guides/man/m3_tt_message/con_set.sgm Normal file
View File

@@ -0,0 +1,96 @@
<!-- $XConsortium: con_set.sgm /main/5 1996/08/30 13:36:18 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.MAN109.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN109.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_set</Function></RefName>
<RefPurpose>set the character string value of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_set.sgm /main/5 1996/08/30 13:36:18 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_context_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_set</Function> function
sets the character string value of a message's context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
This function overwrites any previous value associated with
<Emphasis>slotname</Emphasis>. The
<Symbol Role="Variable">value</Symbol> argument is the character string to be set.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</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-->

103
cde/doc/C/guides/man/m3_tt_message/con_slot.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: con_slot.sgm /main/5 1996/08/30 13:36:28 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.MAN110.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN110.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_slotname</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_slotname</Function></RefName>
<RefPurpose>return the name of a message's nth context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_slot.sgm /main/5 1996/08/30 13:36:28 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>char <Function>*tt_message_context_slotname</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_slotname</Function> function
returns the name of a message's
<Symbol Role="Variable">n</Symbol>th context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the context to be retrieved.
The first context is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_slotname</Function> function returns the contents for the message argument.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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>APPLICATION USAGE</Title>
<Para>The application can use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

105
cde/doc/C/guides/man/m3_tt_message/con_val.sgm Normal file
View File

@@ -0,0 +1,105 @@
<!-- $XConsortium: con_val.sgm /main/5 1996/08/30 13:36:39 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.MAN111.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN111.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_val</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_val</Function></RefName>
<RefPurpose>retrieve the character string of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_val.sgm /main/5 1996/08/30 13:36:39 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>char <Function>*tt_message_context_val</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_val</Function> function
retrieves the character string of a message's context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
</Para>
<Para>If there is no context slot associated with
<Emphasis>slotname</Emphasis>, <Function>tt_message_context_val</Function> returns a
<SystemItem Class="Constant">NULL</SystemItem> pointer.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_val</Function> function returns the contents for the message argument.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

120
cde/doc/C/guides/man/m3_tt_message/con_xval.sgm Normal file
View File

@@ -0,0 +1,120 @@
<!-- $XConsortium: con_xval.sgm /main/7 1996/08/30 13:36:49 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.MAN112.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN112.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_context_xval</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_context_xval</Function></RefName>
<RefPurpose>retrieve and deserialize the data from a message's context
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_context_xval</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>xdrproc_t <Parameter>xdr_proc</Parameter></ParamDef>
<ParamDef>void **<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_context_xval</Function> function
retrieves and deserializes the data from a message's context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
The
<Emphasis>xdr_proc</Emphasis> argument
points to the XDR procedure to be used to deserialize the data in the
<Symbol Role="Variable">n</Symbol>th argument into newly allocated storage,
the address of which will be stored in the pointer whose address is
<Symbol Role="Variable">value</Symbol>.</Para>
<Para>The
<Symbol Role="Variable">value</Symbol> argument is the data to be deserialized.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_context_xval</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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_XDR</Term>
<ListItem>
<Para>The XDR procedure failed on the given data, or evaluated to a
zero-length expression.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The allocation calls are made by the XDR procedure; therefore, any
storage allocated is not allocated from the ToolTalk allocation stack.
The application should use the
<Function>xdr_free</Function>(3) call to free this storage.
</Para>
</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-->

84
cde/doc/C/guides/man/m3_tt_message/cons_cnt.sgm Normal file
View File

@@ -0,0 +1,84 @@
<!-- $XConsortium: cons_cnt.sgm /main/5 1996/08/30 13:36:58 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.MAN113.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN113.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_contexts_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_contexts_count</Function></RefName>
<RefPurpose>return the number of contexts in a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: cons_cnt.sgm /main/5 1996/08/30 13:36:58 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>int <Function>tt_message_contexts_count</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_contexts_count</Function> function
returns the number of contexts in a message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_contexts_count</Function> function returns the total number of contexts in the message.
The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

116
cde/doc/C/guides/man/m3_tt_message/cr_super.sgm Normal file
View File

@@ -0,0 +1,116 @@
<!-- $XConsortium: cr_super.sgm /main/5 1996/08/30 13:37:08 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.MAN115.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN115.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_create_super</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_create_super</Function></RefName>
<RefPurpose>create and re-address a copy of a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: cr_super.sgm /main/5 1996/08/30 13:37:08 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_message <Function>tt_message_create_super</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_create_super</Function> function
creates a copy of the specified message and re-addresses the copy of the
message to the parent of the otype contained within the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_create_super</Function> function returns the opaque unique handle for the re-addressed message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_ADDRESS</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_address</StructName> is invalid.
</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_OBJID</Term>
<ListItem>
<Para>The
objid
passed to the ToolTalk service does not reference an existing object spec.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_OTYPE</Term>
<ListItem>
<Para>The specified object type is not the name of an installed object type.
</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>APPLICATION USAGE</Title>
<Para>The otype of the message
<Emphasis>m</Emphasis> can be determined using the
&cdeman.tt.message.otype; function.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.otype;, &cdeman.tt.message.send;, &cdeman.tt.message.destroy;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

94
cde/doc/C/guides/man/m3_tt_message/create.sgm Normal file
View File

@@ -0,0 +1,94 @@
<!-- $XConsortium: create.sgm /main/5 1996/08/30 13:37:18 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.MAN114.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN114.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_create</Function></RefName>
<RefPurpose>create a new message object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: create.sgm /main/5 1996/08/30 13:37:18 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>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_message <Function>tt_message_create</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_create</Function> function creates a new message object.
</Para>
<Para>The ToolTalk service returns a message handle that is an opaque pointer to a
ToolTalk structure.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_create</Function> function returns the unique opaque handle that identifies the message object.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
</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_PROCID</Term>
<ListItem>
<Para>The process identification is not valid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>A return value of
<SystemItem Class="Constant">TT_ERR_PROCID</SystemItem> implies that
&cdeman.tt.open; was not issued before
<Function>tt_message_create</Function>.</Para>
<Para>If the ToolTalk service is unable to create a message when requested,
<Function>tt_message_create</Function> returns an invalid handle.
When the application attempts to use this handle with another
ToolTalk function, the ToolTalk service will return
<SystemItem Class="Constant">TT_ERR_POINTER</SystemItem>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.open;, &cdeman.tt.message.send;, &cdeman.tt.message.destroy;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

94
cde/doc/C/guides/man/m3_tt_message/destroy.sgm Normal file
View File

@@ -0,0 +1,94 @@
<!-- $XConsortium: destroy.sgm /main/5 1996/08/30 13:37:28 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.MAN116.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN116.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_destroy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_destroy</Function></RefName>
<RefPurpose>destroy a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: destroy.sgm /main/5 1996/08/30 13:37:28 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_destroy</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_destroy</Function> function
destroys the message.
</Para>
<Para>Destroying a message has no effect on the delivery of a message already sent.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_destroy</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>APPLICATION USAGE</Title>
<Para>If the application
sent a request and is expecting a reply with return values,
the application should destroy the
message after it have received the reply.
If the application sends a notice, the application can destroy
the message immediately after it sends the notice.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.create;, &cdeman.tt.message.create.super;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

127
cde/doc/C/guides/man/m3_tt_message/disp_set.sgm Normal file
View File

@@ -0,0 +1,127 @@
<!-- $XConsortium: disp_set.sgm /main/5 1996/08/30 13:37:39 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.MAN118.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN118.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_disposition_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_disposition_set</Function></RefName>
<RefPurpose>set the disposition attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: disp_set.sgm /main/5 1996/08/30 13:37:39 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_disposition_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_disposition <Parameter>r</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_disposition_set</Function> function
sets the disposition attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>r</Emphasis> argument indicates whether an instance of the receiving process
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.
The following values are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DISCARD</Term>
<ListItem>
<Para>There is no receiver for this message.
The message will be returned to the sender with the
<StructName Role="typedef">Tt_status</StructName> field containing
<SystemItem Class="Constant">TT_FAILED</SystemItem>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE</Term>
<ListItem>
<Para>Queue the message until a process of the proper
ptype
receives the message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_START</Term>
<ListItem>
<Para>Attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE+TT_START</Term>
<ListItem>
<Para>Queue the message and attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_disposition_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-->

130
cde/doc/C/guides/man/m3_tt_message/disposit.sgm Normal file
View File

@@ -0,0 +1,130 @@
<!-- $XConsortium: disposit.sgm /main/5 1996/08/30 13:37:53 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.MAN117.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN117.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_disposition</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_disposition</Function></RefName>
<RefPurpose>retrieve the disposition attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: disposit.sgm /main/5 1996/08/30 13:37:53 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_disposition <Function>tt_message_disposition</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_disposition</Function> function
retrieves the disposition attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_disposition</Function> function returns a value that indicates whether an instance of the
receiving process should 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.
The
<Function>tt_message_disposition</Function> function returns one of the following
<StructName Role="typedef">Tt_disposition</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_DISCARD</Term>
<ListItem>
<Para>There is no receiver for this message.
The message will be returned to the sender with the
<StructName Role="typedef">Tt_status</StructName> field containing
<SystemItem Class="Constant">TT_FAILED</SystemItem>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE</Term>
<ListItem>
<Para>Queue the message until a process of the proper
ptype
receives the message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_START</Term>
<ListItem>
<Para>Attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUE+TT_START</Term>
<ListItem>
<Para>Queue the message and attempt to start a process of the proper
ptype
if none is running.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_disposition</StructName> integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

108
cde/doc/C/guides/man/m3_tt_message/fail.sgm Normal file
View File

@@ -0,0 +1,108 @@
<!-- $XConsortium: fail.sgm /main/5 1996/08/30 13:38:05 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.MAN119.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN119.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_fail</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_fail</Function></RefName>
<RefPurpose>indicate a message cannot be handled
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fail.sgm /main/5 1996/08/30 13:38:05 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_fail</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_fail</Function> function
informs the ToolTalk service that the process cannot handle the request just
received.
</Para>
<Para>This function also informs the ToolTalk service that the message is not be
offered to other processes of the same ptype.
The ToolTalk service will send the
message back to the sender with state
<SystemItem Class="Constant">TT_FAILED</SystemItem>.</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_fail</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_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</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>
<Para>The status value must be greater than
<SystemItem Class="Constant">TT_ERR_LAST</SystemItem> to avoid confusion with the ToolTalk service status values.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>To distinguish this case from the case where a message failed because no
matching handler could be found,
the application should place an explanatory message code in the
status attribute of the message with
&cdeman.tt.message.status.set; and
&cdeman.tt.message.status.string.set; before calling
<Function>tt_message_fail</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.status.set;, &cdeman.tt.message.status.string.set;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/m3_tt_message/file.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: file.sgm /main/5 1996/08/30 13:38:14 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.MAN120.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN120.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_file</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_file</Function></RefName>
<RefPurpose>retrieves the file attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: file.sgm /main/5 1996/08/30 13:38:14 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>char <Function>*tt_message_file</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_file</Function> function
retrieves the file attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_file</Function> function returns a string containing
the file attribute of the specified message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/m3_tt_message/file_set.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: file_set.sgm /main/5 1996/08/30 13:38:27 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.MAN121.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN121.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_file_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_file_set</Function></RefName>
<RefPurpose>set the file attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: file_set.sgm /main/5 1996/08/30 13:38:27 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_file_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>file</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_file_set</Function> function
sets the file 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">file</Symbol> argument is the name of the file involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_file_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_FILE</Term>
<ListItem>
<Para>The specified file does not exist or it is inaccessible.
</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-->

62
cde/doc/C/guides/man/m3_tt_message/gid.sgm Normal file
View File

@@ -0,0 +1,62 @@
<!-- $XConsortium: gid.sgm /main/5 1996/08/30 13:38:36 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.MAN122.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN122.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_gid</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_gid</Function></RefName>
<RefPurpose>retrieve the group identifier attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: gid.sgm /main/5 1996/08/30 13:38:36 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>gid_t <Function>tt_message_gid</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_gid</Function> function
retrieves the group identifier attribute from the specified message.
</Para>
<Para>The ToolTalk service automatically sets the group identifier of a message with
the group identifier of the process that created the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_gid</Function> function returns
the group identifier of the message.
If the group
<Literal>nobody</Literal> is returned, the message handle is not valid.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.uid;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

87
cde/doc/C/guides/man/m3_tt_message/han_pt_s.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: han_pt_s.sgm /main/5 1996/08/30 13:38:47 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.MAN125.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN125.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_handler_ptype_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_handler_ptype_set</Function></RefName>
<RefPurpose>set the handler ptype attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: han_pt_s.sgm /main/5 1996/08/30 13:38:47 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_handler_ptype_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_handler_ptype_set</Function> function
sets the handler
ptype
attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>ptid</Emphasis> argument is the type of process that is to handle this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_handler_ptype_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-->

94
cde/doc/C/guides/man/m3_tt_message/han_pty.sgm Normal file
View File

@@ -0,0 +1,94 @@
<!-- $XConsortium: han_pty.sgm /main/5 1996/08/30 13:38:56 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.MAN124.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN124.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_handler_ptype</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_handler_ptype</Function></RefName>
<RefPurpose>retrieve the handler ptype attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: han_pty.sgm /main/5 1996/08/30 13:38:56 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>char <Function>*tt_message_handler_ptype</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_handler_ptype</Function> function
retrieves the handler
ptype
attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_handler_ptype</Function> function returns the
type of process that should handle this message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

86
cde/doc/C/guides/man/m3_tt_message/han_set.sgm Normal file
View File

@@ -0,0 +1,86 @@
<!-- $XConsortium: han_set.sgm /main/5 1996/08/30 13:39:06 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.MAN126.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN126.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_handler_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_handler_set</Function></RefName>
<RefPurpose>set the handler attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: han_set.sgm /main/5 1996/08/30 13:39:06 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_handler_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_handler_set</Function> function
sets the handler attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>procid</Emphasis> argument is the character value that uniquely identifies the
process that is to handle the message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_handler_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-->

98
cde/doc/C/guides/man/m3_tt_message/handler.sgm Normal file
View File

@@ -0,0 +1,98 @@
<!-- $XConsortium: handler.sgm /main/5 1996/08/30 13:39: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.MAN123.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN123.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_handler</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_handler</Function></RefName>
<RefPurpose>retrieve the handler attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: handler.sgm /main/5 1996/08/30 13:39: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>char <Function>*tt_message_handler</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_handler</Function> function
retrieves the handler attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_handler</Function> function returns the character value that uniquely identifies the
process that is to handle the message
(<StructName Role="typedef">Tt_state</StructName> =
<SystemItem Class="Constant">TT_CREATED</SystemItem> or
<SystemItem Class="Constant">TT_SENT</SystemItem>) or the process that
did handle the message
(<StructName Role="typedef">Tt_state</StructName> =
<SystemItem Class="Constant">TT_SENT</SystemItem> or
<SystemItem Class="Constant">TT_HANDLED</SystemItem>). The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

135
cde/doc/C/guides/man/m3_tt_message/iarg_add.sgm Normal file
View File

@@ -0,0 +1,135 @@
<!-- $XConsortium: iarg_add.sgm /main/5 1996/08/30 13:39:25 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.MAN127.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN127.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_iarg_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_iarg_add</Function></RefName>
<RefPurpose>add a new argument to a message object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: iarg_add.sgm /main/5 1996/08/30 13:39:25 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_iarg_add</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_mode <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vtype</Parameter></ParamDef>
<ParamDef>int <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_iarg_add</Function> function
adds a new argument to a message object and sets the value to a given
integer.
</Para>
<Para>Add all arguments before the message is sent.
To change existing argument values, the application must use only modes
<SystemItem Class="Constant">TT_OUT</SystemItem> or
<SystemItem Class="Constant">TT_INOUT</SystemItem>.</Para>
<Para>Adding arguments when replying to a message produces undefined results.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument specifies who (sender, handler, observers)
writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>vtype</Emphasis> argument describes the type of argument data being added.
The
<Symbol Role="Variable">value</Symbol> argument is the value to be added.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_iarg_add</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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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;, &cdeman.tt.message.arg.ival.set;, &cdeman.tt.message.arg.add;, &cdeman.tt.message.barg.add;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

97
cde/doc/C/guides/man/m3_tt_message/ico_set.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: ico_set.sgm /main/5 1996/08/30 13:39:37 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.MAN128.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN128.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_icontext_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_icontext_set</Function></RefName>
<RefPurpose>set the integer value of a message's context
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: ico_set.sgm /main/5 1996/08/30 13:39:37 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_icontext_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>int <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_icontext_set</Function> function
sets the integer value of a message's context.
</Para>
<Para>This function overwrites any previous value associated with
<Emphasis>slotname</Emphasis>.</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the context of this message.
The
<Symbol Role="Variable">value</Symbol> argument is the integer value to be set.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_icontext_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>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</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-->

93
cde/doc/C/guides/man/m3_tt_message/id.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: id.sgm /main/5 1996/08/30 13:39:47 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.MAN129.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN129.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_id</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_id</Function></RefName>
<RefPurpose>retrieve the identifier of a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: id.sgm /main/5 1996/08/30 13:39:47 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>char <Function>*tt_message_id</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_id</Function> function
retrieves the identifier of the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_id</Function> function returns the character string value that uniquely
identifies the message across all running ToolTalk sessions.
The identifier of the message is set at its creation and never changes.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

100
cde/doc/C/guides/man/m3_tt_message/object.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: object.sgm /main/5 1996/08/30 13:39:59 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.MAN130.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN130.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_object</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_object</Function></RefName>
<RefPurpose>retrieve the object attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: object.sgm /main/5 1996/08/30 13:39:59 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>char <Function>*tt_message_object</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_object</Function> function
retrieves the object attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_object</Function> function returns the object involved in this message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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_OBJID</Term>
<ListItem>
<Para>The
objid
passed to the ToolTalk service does not reference an existing object spec.
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

85
cde/doc/C/guides/man/m3_tt_message/object_s.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: object_s.sgm /main/5 1996/08/30 13:40:15 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.MAN131.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN131.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_object_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_object_set</Function></RefName>
<RefPurpose>set the object attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: object_s.sgm /main/5 1996/08/30 13:40:15 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_object_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_object_set</Function> function
sets the object attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>objid</Emphasis> argument is the identifier of the specified object.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_object_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-->

91
cde/doc/C/guides/man/m3_tt_message/op.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: op.sgm /main/5 1996/08/30 13:40:25 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.MAN132.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN132.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_op</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_op</Function></RefName>
<RefPurpose>retrieve the operation attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: op.sgm /main/5 1996/08/30 13:40:25 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>char <Function>*tt_message_op</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_op</Function> function
retrieves the operation attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_op</Function> function returns the operation which the receiving process is to perform.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

85
cde/doc/C/guides/man/m3_tt_message/op_set.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: op_set.sgm /main/5 1996/08/30 13:40:35 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.MAN133.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN133.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_op_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_op_set</Function></RefName>
<RefPurpose>set the operation attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: op_set.sgm /main/5 1996/08/30 13:40:35 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_op_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>opname</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_op_set</Function> function
sets the operation attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>opname</Emphasis> argument is the operation that the receiving process is to perform.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_op_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-->

84
cde/doc/C/guides/man/m3_tt_message/opnum.sgm Normal file
View File

@@ -0,0 +1,84 @@
<!-- $XConsortium: opnum.sgm /main/5 1996/08/30 13:40:47 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.MAN134.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN134.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_opnum</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_opnum</Function></RefName>
<RefPurpose>retrieve the operation number attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: opnum.sgm /main/5 1996/08/30 13:40:47 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>int <Function>tt_message_opnum</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_opnum</Function> function
retrieves the operation number attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_opnum</Function> function returns the number of the operation involved in this message.
The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

91
cde/doc/C/guides/man/m3_tt_message/otype.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: otype.sgm /main/5 1996/08/30 13:40:58 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.MAN135.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN135.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_otype</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_otype</Function></RefName>
<RefPurpose>retrieve the object type attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: otype.sgm /main/5 1996/08/30 13:40:58 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>char <Function>*tt_message_otype</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_otype</Function> function
retrieves the object type attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_otype</Function> function returns the type of the object involved in this message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

93
cde/doc/C/guides/man/m3_tt_message/otype_s.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: otype_s.sgm /main/5 1996/08/30 13:41:08 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.MAN136.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN136.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_otype_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_otype_set</Function></RefName>
<RefPurpose>set the otype attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: otype_s.sgm /main/5 1996/08/30 13:41:08 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_otype_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>otype</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_otype_set</Function> function
sets the object type
(<Emphasis>otype</Emphasis>) attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>otype</Emphasis> argument is the type of the object involved in this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_otype_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_OTYPE</Term>
<ListItem>
<Para>The specified object type is not the name of an installed object type.
</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-->

93
cde/doc/C/guides/man/m3_tt_message/pattern.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: pattern.sgm /main/5 1996/08/30 13:41:19 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.MAN137.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN137.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_pattern</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_pattern</Function></RefName>
<RefPurpose>return the pattern matched by a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pattern.sgm /main/5 1996/08/30 13:41:19 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_pattern <Function>tt_message_pattern</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_pattern</Function> function
returns the pattern that the specified message matched.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_pattern</Function> function returns the opaque handle for a message pattern.
The application can use
&cdeman.tt.ptr.error; to determine if the handle is valid.
The
<Function>tt_message_pattern</Function> function returns 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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

96
cde/doc/C/guides/man/m3_tt_message/print.sgm Normal file
View File

@@ -0,0 +1,96 @@
<!-- $XConsortium: print.sgm /main/5 1996/08/30 13:41:28 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.MAN138.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN138.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_print</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_print</Function></RefName>
<RefPurpose>format a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: print.sgm /main/5 1996/08/30 13:41:28 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>char <Function>*tt_message_print</Function></FuncDef>
<ParamDef>Tt_message *<Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_print</Function> function
formats a message in the same way a message
is formatted for the
&cdeman.ttsession; trace and returns a string containing it.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the message to be formatted.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_print</Function> function returns the formatted string.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMEM</Term>
<ListItem>
<Para>There is insufficient memory available to perform the function.
</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>APPLICATION USAGE</Title>
<Para>The
<Function>tt_message_print</Function> function allows an application to dump out
messages that are received but not understood.
</Para>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.free;, &cdeman.tt.ptr.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

95
cde/doc/C/guides/man/m3_tt_message/receive.sgm Normal file
View File

@@ -0,0 +1,95 @@
<!-- $XConsortium: receive.sgm /main/5 1996/08/30 13:41:40 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.MAN139.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN139.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_receive</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_receive</Function></RefName>
<RefPurpose>receive a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: receive.sgm /main/5 1996/08/30 13:41:40 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>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_message <Function>tt_message_receive</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_receive</Function> function returns a handle for the next message queued to be delivered
to the process and also runs any message or pattern callbacks
applicable to the queued message.
</Para>
<Para>If the return value of
&cdeman.tt.message.status; for this message is
<SystemItem Class="Constant">TT_WRN_START_MESSAGE</SystemItem>, the ToolTalk service started the process to deliver the queued message;
the process must reply to this message.
If the return value of
<Function>tt_message_receive</Function> is zero, no message is available.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_receive</Function> function returns the handle for the message object.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned handle:
</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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>A zero value can occur if a message or pattern callback processes the message.
It can also occur if the interval is too long between the time the file
descriptor became active and the
<Function>tt_message_receive</Function> call was made.
In the latter case, the ToolTalk service will time out and offer the message to
another process.
</Para>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

90
cde/doc/C/guides/man/m3_tt_message/reject.sgm Normal file
View File

@@ -0,0 +1,90 @@
<!-- $XConsortium: reject.sgm /main/5 1996/08/30 13:41:52 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.MAN140.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN140.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_reject</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_reject</Function></RefName>
<RefPurpose>reject a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: reject.sgm /main/5 1996/08/30 13:41:52 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_reject</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_reject</Function> function
informs the ToolTalk service that the process cannot handle this message.
The ToolTalk service will attempt to deliver the message to other handlers.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_reject</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_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</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-->

107
cde/doc/C/guides/man/m3_tt_message/reject_c.sgm Normal file
View File

@@ -0,0 +1,107 @@
<!-- $XConsortium: reject_c.sgm /main/3 1996/08/30 13:42:04 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.MAN331.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN331.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_rejecters_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_rejecters_count</Function></RefName>
<RefPurpose>return a count of the offer's rejecting procids
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>tt_message_rejecters_count</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_rejecters_count</Function>
function
returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having rejected it.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_rejecters_count</Function>
function returns a count of the procids that are recorded in the
offer
<Emphasis>m</Emphasis>
as having rejected it.
The application can use
<Function>tt_int_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned integer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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;,
&cdeman.tt.message.rejecter;,
&cdeman.tt.int.error;.
</Para>
</RefSect1>
</RefEntry>

126
cde/doc/C/guides/man/m3_tt_message/rejecter.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: rejecter.sgm /main/5 1996/08/30 13:42: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.MAN332.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN332.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_rejecter</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_rejecter</Function></RefName>
<RefPurpose>return offer's nth rejecting procid
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char *<Function>tt_message_rejecter</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_rejecter</Function>
function
returns the procid of the
<Symbol Role="Variable">n</Symbol>th
rejecter of the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis>
argument is the opaque handle for the message involved in this operation.
The
<Emphasis>n</Emphasis>
argument is the number of the rejecter to be returned.
The first rejecter is numbered zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_rejecter</Function>
function returns the procid of the
<Symbol Role="Variable">n</Symbol>th
rejecter.
The application can use
<Function>tt_ptr_error</Function>
to extract one of the following
<StructName Role="typedef">Tt_status</StructName>
values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>There is no valid default procid, perhaps because
<Function>tt_open</Function>
has not yet been called.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_STATE</Term>
<ListItem>
<Para>The specified message is not in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>.
Since only
<SystemItem Class="Constant">TT_OFFER</SystemItem>s
can be in state
<SystemItem Class="Constant">TT_RETURNED</SystemItem>,
this status will be returned if the specified message is a
<SystemItem Class="Constant">TT_NOTICE</SystemItem>
or a
<SystemItem Class="Constant">TT_REQUEST</SystemItem>.
</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>APPLICATION USAGE</Title>
<Para>The application can use
<Function>tt_free</Function>
to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.message.rejecters.count;,
&cdeman.tt.ptr.error;,
&cdeman.tt.free;.
</Para>
</RefSect1>
</RefEntry>

100
cde/doc/C/guides/man/m3_tt_message/reply.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: reply.sgm /main/5 1996/08/30 13:42:50 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.MAN141.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN141.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_reply</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_reply</Function></RefName>
<RefPurpose>reply to a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: reply.sgm /main/5 1996/08/30 13:42:50 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_reply</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_reply</Function> function
informs the ToolTalk service that the process has handled the message and
filled in all return values.
</Para>
<Para>The ToolTalk service sends the message back to the sending process and fills in
the state attribute with
<SystemItem Class="Constant">TT_HANDLED</SystemItem>.</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_reply</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_NOTHANDLER</Term>
<ListItem>
<Para>This application is not the handler for this message.
</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>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</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-->

120
cde/doc/C/guides/man/m3_tt_message/scope.sgm Normal file
View File

@@ -0,0 +1,120 @@
<!-- $XConsortium: scope.sgm /main/5 1996/08/30 13:43:04 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.MAN142.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN142.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_scope</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_scope</Function></RefName>
<RefPurpose>retrieve the scope attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: scope.sgm /main/5 1996/08/30 13:43:04 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_scope <Function>tt_message_scope</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_scope</Function> function
retrieves the scope attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_scope</Function> function returns a value that 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>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_scope</StructName> integer return value:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

118
cde/doc/C/guides/man/m3_tt_message/scope_s.sgm Normal file
View File

@@ -0,0 +1,118 @@
<!-- $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-->

151
cde/doc/C/guides/man/m3_tt_message/send.sgm Normal file
View File

@@ -0,0 +1,151 @@
<!-- $XConsortium: send.sgm /main/5 1996/08/30 13:43:28 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.MAN144.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN144.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_send</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_send</Function></RefName>
<RefPurpose>send a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: send.sgm /main/5 1996/08/30 13:43:28 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_send</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_send</Function> function
sends the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_send</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_ADDRESS</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_address</StructName> is invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_CLASS</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_class</StructName> is invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_FILE</Term>
<ListItem>
<Para>The specified file does not exist or it is inaccessible.
</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_OBJID</Term>
<ListItem>
<Para>The
objid
passed to the ToolTalk service does not reference an existing object spec.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_OTYPE</Term>
<ListItem>
<Para>The specified object type is not the name of an installed object type.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_OVERFLOW</Term>
<ListItem>
<Para>The ToolTalk service has more active messages than it can handle.
(The maximum number of active messages is implementation specific,
but is at least 2000.)
</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>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_SESSION</Term>
<ListItem>
<Para>The specified ToolTalk session is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_WRN_STALE_OBJID</Term>
<ListItem>
<Para>The object attribute in the message has been replaced with a newer one.
</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-->

92
cde/doc/C/guides/man/m3_tt_message/sender.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: sender.sgm /main/5 1996/08/30 13:43:41 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.MAN146.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN146.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_sender</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_sender</Function></RefName>
<RefPurpose>retrieve the sender attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: sender.sgm /main/5 1996/08/30 13:43:41 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>char <Function>*tt_message_sender</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_sender</Function> function
retrieves the sender attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_sender</Function> function returns the character value that uniquely identifies
the sending process.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

85
cde/doc/C/guides/man/m3_tt_message/sessio_s.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: sessio_s.sgm /main/5 1996/08/30 13:43:52 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.MAN150.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN150.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_session_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_session_set</Function></RefName>
<RefPurpose>set the session attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: sessio_s.sgm /main/5 1996/08/30 13:43:52 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_session_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_session_set</Function> function
sets the session attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>sessid</Emphasis> argument is the identifier of the session in which the process is interested.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_session_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-->

91
cde/doc/C/guides/man/m3_tt_message/session.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: session.sgm /main/5 1996/08/30 13:44:04 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.MAN149.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN149.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_session</Function></RefName>
<RefPurpose>retrieve the session attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: session.sgm /main/5 1996/08/30 13:44:04 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>char <Function>*tt_message_session</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_session</Function> function
retrieves the session attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_session</Function> function returns the identifier of the session to which this message applies.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

132
cde/doc/C/guides/man/m3_tt_message/snd_on_e.sgm Normal file
View File

@@ -0,0 +1,132 @@
<!-- $XConsortium: snd_on_e.sgm /main/6 1996/08/30 13:44:18 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.MAN145.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN145.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_send_on_exit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_send_on_exit</Function></RefName>
<RefPurpose>set up a message to send upon unexpected exit
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: snd_on_e.sgm /main/6 1996/08/30 13:44:18 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_send_on_exit</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_send_on_exit</Function> function
requests that the ToolTalk service send this message if
the process exits unexpectedly.
The message is sent to the ToolTalk service, which queues the message
internally until either of two events occur:
</Para>
<OrderedList>
<ListItem>
<Para>The procid that sent the
<Function>tt_message_send_on_exit</Function> message to the ToolTalk service calls
&cdeman.tt.close;. In this case, the queued message is deleted.
</Para>
</ListItem>
<ListItem>
<Para>The connection between the
&cdeman.ttsession; server and the process that sent the
<Function>tt_message_send_on_exit</Function> message to the ToolTalk service is broken; for
example, if the application has crashed.
</Para>
</ListItem>
</OrderedList>
<Para>In this case, the ToolTalk service matches the queued message to its patterns
and delivers it in the same manner as if the process had sent the message
normally before exiting.
</Para>
<Para>If a process sends a normal termination message but exits without calling
&cdeman.tt.close;, both the normal termination message and the on_exit message are
delivered.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_send_on_exit</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_ADDRESS</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_address</StructName> is invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_CLASS</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_class</StructName> is invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_FILE</Term>
<ListItem>
<Para>The specified file does not exist or it is inaccessible.
</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_OBJID</Term>
<ListItem>
<Para>The
objid
passed to the ToolTalk service does not reference an existing object spec.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.close;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

87
cde/doc/C/guides/man/m3_tt_message/snd_pt_s.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: snd_pt_s.sgm /main/5 1996/08/30 13:44:31 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.MAN148.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN148.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_sender_ptype_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_sender_ptype_set</Function></RefName>
<RefPurpose>set the sender ptype attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: snd_pt_s.sgm /main/5 1996/08/30 13:44:31 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_sender_ptype_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_sender_ptype_set</Function> function
sets the sender
ptype
attribute for the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>ptid</Emphasis> argument is the type of process that is sending this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_sender_ptype_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-->

93
cde/doc/C/guides/man/m3_tt_message/snd_pty.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: snd_pty.sgm /main/5 1996/08/30 13:44:44 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.MAN147.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN147.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_sender_ptype</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_sender_ptype</Function></RefName>
<RefPurpose>retrieve the sender ptype attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: snd_pty.sgm /main/5 1996/08/30 13:44:44 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>char <Function>*tt_message_sender_ptype</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_sender_ptype</Function> function
retrieves the sender
ptype
attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_sender_ptype</Function> function returns the sending process.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

92
cde/doc/C/guides/man/m3_tt_message/st_str.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: st_str.sgm /main/5 1996/08/30 13:44:56 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.MAN154.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN154.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_status_string</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_status_string</Function></RefName>
<RefPurpose>retrieve the character string stored with the status attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: st_str.sgm /main/5 1996/08/30 13:44:56 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>char <Function>*tt_message_status_string</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_status_string</Function> function
retrieves the character string stored with the status attribute for the
specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_status_string</Function> function returns the status string stored in this message.
The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.status;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

90
cde/doc/C/guides/man/m3_tt_message/st_str_s.sgm Normal file
View File

@@ -0,0 +1,90 @@
<!-- $XConsortium: st_str_s.sgm /main/5 1996/08/30 13:45:09 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.MAN155.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN155.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_status_string_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_status_string_set</Function></RefName>
<RefPurpose>set a character string with the status attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: st_str_s.sgm /main/5 1996/08/30 13:45:09 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_status_string_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>status_str</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_status_string_set</Function> function sets status string of the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>status_str</Emphasis> argument is the status string to be stored in this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_status_string_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>APPLICATION USAGE</Title>
<Para>The status string should be used by the application developer
to amplify on, for example, why the application is failing a message.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.status.set;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

141
cde/doc/C/guides/man/m3_tt_message/state.sgm Normal file
View File

@@ -0,0 +1,141 @@
<!-- $XConsortium: state.sgm /main/5 1996/08/30 13:45:20 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.MAN151.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN151.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_state</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_state</Function></RefName>
<RefPurpose>retrieve the state attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: state.sgm /main/5 1996/08/30 13:45:20 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_state <Function>tt_message_state</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_state</Function> function
retrieves the state attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_state</Function> function returns a value that indicates the current delivery
state of the message.
The
<Function>tt_message_state</Function> function returns one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_CREATED</Term>
<ListItem>
<Para>The message has been created, but not yet sent.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_SENT</Term>
<ListItem>
<Para>The message has been sent, but not yet handled.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_HANDLED</Term>
<ListItem>
<Para>The message has been handled; return values are valid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_FAILED</Term>
<ListItem>
<Para>The message could not be delivered to a handler.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_QUEUED</Term>
<ListItem>
<Para>The message has been queued for delivery.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_STARTED</Term>
<ListItem>
<Para>The ToolTalk service is attempting to start a process to handle the message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_REJECTED</Term>
<ListItem>
<Para>The message has been rejected by a possible handler.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the
<StructName Role="typedef">Tt_state</StructName> integer return value:
</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;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

85
cde/doc/C/guides/man/m3_tt_message/status.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: status.sgm /main/5 1996/08/30 13:45:32 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.MAN152.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN152.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_status</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_status</Function></RefName>
<RefPurpose>retrieve the status attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: status.sgm /main/5 1996/08/30 13:45:32 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>int <Function>tt_message_status</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_status</Function> function
retrieves the status attribute from the specified message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_status</Function> function returns an integer that describes the status
stored in the status attribute of this message.
The application can use
&cdeman.tt.int.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned integer:
</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;, &cdeman.tt.message.status.string;, &cdeman.tt.int.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

88
cde/doc/C/guides/man/m3_tt_message/status_s.sgm Normal file
View File

@@ -0,0 +1,88 @@
<!-- $XConsortium: status_s.sgm /main/5 1996/08/30 13:45:46 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.MAN153.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN153.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_status_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_status_set</Function></RefName>
<RefPurpose>set the status attribute for a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: status_s.sgm /main/5 1996/08/30 13:45:46 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_status_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>status</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_status_set</Function> function
sets the status 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">status</Symbol> argument is the status to be stored in this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_status_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>
<Para>The status value must be greater than
<SystemItem Class="Constant">TT_ERR_LAST</SystemItem> to avoid confusion with the ToolTalk service status values.
</Para>
</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-->

63
cde/doc/C/guides/man/m3_tt_message/uid.sgm Normal file
View File

@@ -0,0 +1,63 @@
<!-- $XConsortium: uid.sgm /main/5 1996/08/30 13:45:57 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.MAN156.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN156.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_uid</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_uid</Function></RefName>
<RefPurpose>retrieve the user identifier attribute from a message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: uid.sgm /main/5 1996/08/30 13:45:57 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>uid_t <Function>tt_message_uid</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_uid</Function> function
retrieves the user identifier attribute from the specified message.
</Para>
<Para>The ToolTalk service automatically sets the user identifier of a message with
the user identifier of the process that created the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_uid</Function> function returns
the user identifier of the message.
If the group
<Literal>nobody</Literal> is returned, the
message handle is not valid.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.gid;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

108
cde/doc/C/guides/man/m3_tt_message/user.sgm Normal file
View File

@@ -0,0 +1,108 @@
<!-- $XConsortium: user.sgm /main/5 1996/08/30 13:46:07 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.MAN157.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN157.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_user</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_user</Function></RefName>
<RefPurpose>retrieve the user information associated with a message object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: user.sgm /main/5 1996/08/30 13:46:07 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>void <Function>*tt_message_user</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>key</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_user</Function> function
retrieves the user information stored in data cells associated with the
specified message object.
</Para>
<Para>The user data is part of the message object
(that is, the storage buffer in the
application); it is not a part of the actual message.
The application can, therefore, only
retrieve user information that the application placed in the message.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">key</Symbol> argument is the user data cell to be retrieved.
The user data cell must be unique for this message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_user</Function> function returns the data cell,
a piece of arbitrary user data that can hold a
<Literal>void&ensp;*</Literal>. The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned data:
</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>APPLICATION USAGE</Title>
<Para>The application should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
<Para>The user data cell is intended to hold an address.
If the address selected is equal to one of the
<StructName Role="typedef">Tt_status</StructName> enumerated values, the result of the
&cdeman.tt.ptr.error; function will not be reliable.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

104
cde/doc/C/guides/man/m3_tt_message/user_set.sgm Normal file
View File

@@ -0,0 +1,104 @@
<!-- $XConsortium: user_set.sgm /main/5 1996/08/30 13:46:19 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.MAN158.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN158.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_user_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_user_set</Function></RefName>
<RefPurpose>stores user information associated with a message object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: user_set.sgm /main/5 1996/08/30 13:46:19 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_user_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>int <Parameter>key</Parameter></ParamDef>
<ParamDef>void *<Parameter>v</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_user_set</Function> function
stores user information in data cells associated with the specified message
object.
</Para>
<Para>The user data is part of the message object (that is, the storage buffer in
the application); it is not part of the actual message.
Data stored by the sending
process in user data cells is not seen by handlers and observers.
The application can use arguments
for data that needs to be seen by handlers or observers.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">key</Symbol> argument is the user data cell in which user information is to be stored.
The
<Emphasis>v</Emphasis> argument is the data cell,
a piece of arbitrary user data that can hold a
<Literal>void&ensp;*</Literal>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_user_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>
<VarListEntry>
<Term>TT_ERR_PROCID</Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.message.arg.add;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

139
cde/doc/C/guides/man/m3_tt_message/xarg_add.sgm Normal file
View File

@@ -0,0 +1,139 @@
<!-- $XConsortium: xarg_add.sgm /main/7 1996/08/30 13:46:30 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.MAN159.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN159.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_xarg_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_xarg_add</Function></RefName>
<RefPurpose>add an argument with an XDR-interpreted value to a message object
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_xarg_add</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>Tt_mode <Parameter>n</Parameter></ParamDef>
<ParamDef>const char *<Parameter>vtype</Parameter></ParamDef>
<ParamDef>xdrproc_t <Parameter>xdr_proc</Parameter></ParamDef>
<ParamDef>void *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_xarg_add</Function> function
adds an argument with an XDR-interpreted value to a message object.
</Para>
<Para>To change existing argument values, the application must use only modes
<SystemItem Class="Constant">TT_OUT</SystemItem> or
<SystemItem Class="Constant">TT_INOUT</SystemItem>.</Para>
<Para>Adding arguments when replying to a message produces undefined results.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument specifies who
(sender, handler, observers) writes and reads a message argument.
The following modes are defined:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_IN</Term>
<ListItem>
<Para>The argument is written by the sender and read by the
handler and any observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_OUT</Term>
<ListItem>
<Para>The argument is written by the handler and read by the
sender and any reply observers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_INOUT</Term>
<ListItem>
<Para>The argument is written by the sender and the
handler and read by all.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>vtype</Emphasis> argument describes the type of argument data being added.
The
<Emphasis>xdr_proc</Emphasis> argument points to the XDR procedure to be used to serialize the data
pointed to by
<Symbol Role="Variable">value</Symbol>. The
<Symbol Role="Variable">value</Symbol> argument is the data to be serialized.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_xarg_add</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_MODE</Term>
<ListItem>
<Para>The specified
<StructName Role="typedef">Tt_mode</StructName> is invalid.
</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>
<VarListEntry>
<Term>TT_ERR_XDR</Term>
<ListItem>
<Para>The XDR procedure failed on the given data, or evaluated to a
zero-length expression.
</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-->

103
cde/doc/C/guides/man/m3_tt_message/xco_set.sgm Normal file
View File

@@ -0,0 +1,103 @@
<!-- $XConsortium: xco_set.sgm /main/7 1996/08/30 13:46:43 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.MAN161.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN161.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_message_xcontext_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_message_xcontext_set</Function></RefName>
<RefPurpose>set the XDR-interpreted byte-array value of a message's context
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_message_xcontext_set</Function></FuncDef>
<ParamDef>Tt_message <Parameter>m</Parameter></ParamDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>xdrproc_t <Parameter>xdr_proc</Parameter></ParamDef>
<ParamDef>void *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_message_xcontext_set</Function> function
sets the XDR-interpreted byte-array value of a message's context.
</Para>
<Para>The
<Emphasis>m</Emphasis> argument is the opaque handle for the message involved in this operation.
The
<Emphasis>slotname</Emphasis> argument describes the slotname in this message.
The
<Symbol Role="Variable">value</Symbol> argument is the byte string with the contents for the message argument.
The
<Emphasis>xdr_proc</Emphasis> argument
points to the XDR procedure
to be used to serialize the data pointed to by
<Symbol Role="Variable">value</Symbol>. The
<Symbol Role="Variable">value</Symbol> argument is the data to be serialized.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_message_xcontext_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 does not point at an object of the correct type for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_SLOTNAME</Term>
<ListItem>
<Para>The specified slotname is syntactically invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_XDR</Term>
<ListItem>
<Para>The XDR procedure failed on the given data, or evaluated to a
zero-length expression.
</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-->