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

96
cde/doc/C/guides/man/m3_tt/X_sessio.sgm Normal file
View File

@@ -0,0 +1,96 @@
<!-- $XConsortium: X_sessio.sgm /main/5 1996/08/30 12:42:48 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.MAN53.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN53.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_X_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_X_session</Function></RefName>
<RefPurpose>return the session associated with an X window system display
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: X_sessio.sgm /main/5 1996/08/30 12:42:48 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_X_session</Function></FuncDef>
<ParamDef>const char *<Parameter>xdisplaystring</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_X_session</Function> function
returns the session associated with the named X window system display.
</Para>
<Para>The application can call
<Function>tt_X_session</Function> before it calls
&cdeman.tt.open;.</Para>
<Para>The
<Emphasis>xdisplaystring</Emphasis> argument is the name of an X display server; for example,
<Literal>somehost:0</Literal> or
<Literal>:0</Literal>.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_X_session</Function> function returns the identifier for the ToolTalk session
associated with the named X window system display.
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_SESSION</Term>
<ListItem>
<Para>The
<Emphasis>xdisplaystring</Emphasis> does not name an X display.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_POINTER</Term>
<ListItem>
<Para>The
<Emphasis>xdisplaystring</Emphasis> is
<SystemItem Class="Constant">NULL</SystemItem>.</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.open;, &cdeman.tt.free;.</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/bco_join.sgm Normal file
View File

@@ -0,0 +1,94 @@
<!-- $XConsortium: bco_join.sgm /main/5 1996/08/30 12:43:03 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.MAN54.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN54.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_bcontext_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_bcontext_join</Function></RefName>
<RefPurpose>add a byte-array value to the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bco_join.sgm /main/5 1996/08/30 12:43:03 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_bcontext_join</Function></FuncDef>
<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_bcontext_join</Function> function
adds the given byte-array value to the list of values for the named contexts
of all patterns.
The context is compared to currently registered patterns for the
procid.
If a
pattern has a slot with the specified name,
the given byte-array value is added
to the list of values for that slot.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
The
<Symbol Role="Variable">value</Symbol> argument is the value to be added.
The
<Symbol Role="Variable">length</Symbol> argument is the length in bytes of the value.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_bcontext_join</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_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-->

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

@@ -0,0 +1,92 @@
<!-- $XConsortium: bco_quit.sgm /main/5 1996/08/30 12:43:13 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.MAN55.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN55.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_bcontext_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_bcontext_quit</Function></RefName>
<RefPurpose>remove a byte-array value from the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bco_quit.sgm /main/5 1996/08/30 12:43:13 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_bcontext_quit</Function></FuncDef>
<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_bcontext_quit</Function> function removes the given byte-array value from the list of values for
the contexts of all patterns.
The context is compared to currently registered patterns for the
procid.
If a pattern has a slot with the specified name, the given byte string
value is removed from the list of values for that slot.
If there are duplicate values, only one value is removed.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
The
<Symbol Role="Variable">value</Symbol> argument is the value to be removed.
The
<Symbol Role="Variable">length</Symbol> argument is the length in bytes of the value.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_bcontext_quit</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_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-->

91
cde/doc/C/guides/man/m3_tt/close.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: close.sgm /main/5 1996/08/30 12:43:22 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.MAN56.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN56.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_close</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_close</Function></RefName>
<RefPurpose>close the current default procid
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: close.sgm /main/5 1996/08/30 12:43:22 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_status <Function>tt_close</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_close</Function> function
closes the current default
procid.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_close</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_PROCID</Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>When the
<Function>tt_close</Function> function call is successful, the
procid
will no longer be active.
For any subsequent API calls the process must, therefore,
first call
<Function>tt_default_procid_set</Function> to specify a
procid.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.open;, &cdeman.tt.context.join;.</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/con_join.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: con_join.sgm /main/5 1996/08/30 12:43: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.MAN57.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN57.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_context_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_context_join</Function></RefName>
<RefPurpose>add a string value to the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_join.sgm /main/5 1996/08/30 12:43: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>Tt_status <Function>tt_context_join</Function></FuncDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_context_join</Function> function
adds the given string value to the list of values for the context of all
patterns.
</Para>
<Para>The context is compared to currently registered patterns for the
procid.
If a
pattern has a slot with the specified name, the given string value is added to
the list of values for that slot.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
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_context_join</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_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/con_quit.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: con_quit.sgm /main/5 1996/08/30 12: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.MAN58.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN58.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_context_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_context_quit</Function></RefName>
<RefPurpose>remove a string value from the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: con_quit.sgm /main/5 1996/08/30 12: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>Tt_status <Function>tt_context_quit</Function></FuncDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_context_quit</Function> function
removes the given string value from the list of values for the contexts of all
patterns.
</Para>
<Para>The context is compared to currently registered patterns for the
procid.
If a
pattern has a slot with the specified name,
<Function>tt_context_quit</Function> removes the given string value
from the list of values for that slot.
If there are duplicate values, only one value is removed.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
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_context_quit</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_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-->

89
cde/doc/C/guides/man/m3_tt/def_fi_s.sgm Normal file
View File

@@ -0,0 +1,89 @@
<!-- $XConsortium: def_fi_s.sgm /main/5 1996/08/30 12:43: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.MAN60.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN60.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_file_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_file_set</Function></RefName>
<RefPurpose>set the default file to a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_fi_s.sgm /main/5 1996/08/30 12:43: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_default_file_set</Function></FuncDef>
<ParamDef>const char *<Parameter>docid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_file_set</Function> function
sets the default file to the specified file.
</Para>
<Para>The
<Emphasis>docid</Emphasis> argument is a pointer to a character string
that specifies the file that is to be the default file.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_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_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 current default process identifier is out of date or 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>
</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/def_file.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: def_file.sgm /main/5 1996/08/30 12:44:00 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.MAN59.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN59.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_file</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_file</Function></RefName>
<RefPurpose>return the current default file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_file.sgm /main/5 1996/08/30 12:44:00 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>char <Function>*tt_default_file</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_file</Function> function
returns the current default file.
</Para>
<Para>When the application joins a file, the file becomes the default.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_file</Function> function returns the pointer to a character string that specifies the
current default file.
If the pointer is
<SystemItem Class="Constant">NULL</SystemItem>, no default file is set.
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_PROCID</Term>
<ListItem>
<Para>The current default process identifier is out of date or 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.file.join;, &cdeman.tt.default.file.set;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

82
cde/doc/C/guides/man/m3_tt/def_pr_s.sgm Normal file
View File

@@ -0,0 +1,82 @@
<!-- $XConsortium: def_pr_s.sgm /main/5 1996/08/30 12:44:11 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.MAN62.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN62.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_procid_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_procid_set</Function></RefName>
<RefPurpose>set the current default procid
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_pr_s.sgm /main/5 1996/08/30 12:44:11 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_default_procid_set</Function></FuncDef>
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_procid_set</Function> function
sets the current default
procid.
</Para>
<Para>The
<Emphasis>procid</Emphasis> argument is the name of process that is to be the default process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_procid_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_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.open;.</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/def_proc.sgm Normal file
View File

@@ -0,0 +1,90 @@
<!-- $XConsortium: def_proc.sgm /main/5 1996/08/30 12:44: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.MAN61.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN61.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_procid</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_procid</Function></RefName>
<RefPurpose>identify the current default process
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_proc.sgm /main/5 1996/08/30 12:44: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>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tt_default_procid</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_procid</Function> function
retrieves the current default
procid
for the process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_procid</Function> function returns the pointer to a character string that uniquely
identifies the current default 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_PROCID</Term>
<ListItem>
<Para>The current default process identifier is out of date or 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-->

83
cde/doc/C/guides/man/m3_tt/def_pt_s.sgm Normal file
View File

@@ -0,0 +1,83 @@
<!-- $XConsortium: def_pt_s.sgm /main/5 1996/08/30 12: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.MAN64.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN64.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_ptype_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_ptype_set</Function></RefName>
<RefPurpose>set the default ptype
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_pt_s.sgm /main/5 1996/08/30 12: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_default_ptype_set</Function></FuncDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_ptype_set</Function> function
sets the default ptype.
</Para>
<Para>The
<Emphasis>ptid</Emphasis> argument must be
the character string that uniquely identifies the process that is
to be the default process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_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_PROCID</Term>
<ListItem>
<Para>The current default 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-->

98
cde/doc/C/guides/man/m3_tt/def_ptyp.sgm Normal file
View File

@@ -0,0 +1,98 @@
<!-- $XConsortium: def_ptyp.sgm /main/5 1996/08/30 12:44:42 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.MAN63.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN63.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_ptype</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_ptype</Function></RefName>
<RefPurpose>retrieve the current default ptype
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_ptyp.sgm /main/5 1996/08/30 12:44:42 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>char <Function>*tt_default_ptype</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_ptype</Function> function
retrieves the current default ptype.
</Para>
<Para>When the application declares a
ptype,
the
ptype
becomes the default.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_ptype</Function> function returns a pointer to a character string that uniquely
identifies the current default process type.
If the pointer is
<SystemItem Class="Constant">NULL</SystemItem>, no default
ptype
is set.
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_PROCID</Term>
<ListItem>
<Para>The current default process identifier is out of date or 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.ptype.declare;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

131
cde/doc/C/guides/man/m3_tt/def_se_s.sgm Normal file
View File

@@ -0,0 +1,131 @@
<!-- $XConsortium: def_se_s.sgm /main/6 1996/09/08 20:12:01 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.MAN66.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN66.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_session_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_session_set</Function></RefName>
<RefPurpose>set the current default session identifier
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_se_s.sgm /main/6 1996/09/08 20:12:01 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_default_session_set</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_session_set</Function> function
sets the current default session identifier.
</Para>
<Para>The ToolTalk service uses the initial user session as the default session and
supports one session per
procid.
The application can make this call before it
calls
&cdeman.tt.open; to specify the session to which it wants to connect.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is a pointer to the unique identifier
for the session in which the procid is interested.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_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_PROCID</Term>
<ListItem>
<Para>The current default 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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>To change to another opened session, the application must use the
<Function>tt_default_procid_set</Function> function.
</Para>
<Para>To join other sessions, the procid must first set the new session as the
default session, and then initialize and register with the ToolTalk service.
The calls required must be in the following order:
</Para>
<InformalExample Remap="indent">
<ProgramListing><Function>tt_default_session_set</Function>
<Function>tt_open</Function></ProgramListing>
</InformalExample>
<Para>The
&cdeman.tt.open; may create another ToolTalk procid, the connection to which is
identified by a procid.
Only one ToolTalk session per procid is allowed.
(However, multiple procids are allowed in a client.)
There are no API calls to determine to which session a particular
procid
is connected.
If it is important for the application to know the session
to which it is connected, it must make the following calls in the indicated
order:
</Para>
<InformalExample Remap="indent">
<ProgramListing><Function>tt_open</Function>
<Function>tt_default_session</Function></ProgramListing>
</InformalExample>
<Para>The application can then store the information by indexing it by the
procid
returned by the
&cdeman.tt.open; call.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.open;, &cdeman.tt.default.procid;, &cdeman.tt.default.session;.</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/def_sess.sgm Normal file
View File

@@ -0,0 +1,96 @@
<!-- $XConsortium: def_sess.sgm /main/5 1996/08/30 12:45:02 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.MAN65.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN65.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_default_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_default_session</Function></RefName>
<RefPurpose>retrieve the current default session identifier
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: def_sess.sgm /main/5 1996/08/30 12:45:02 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>char <Function>*tt_default_session</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_default_session</Function> function
retrieves the current default session identifier.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_default_session</Function> function returns the pointer to the unique identifier for the
current default session.
If the pointer is
<SystemItem Class="Constant">NULL</SystemItem>, no default session is set.
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_PROCID</Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>A session can have more than one session identifier.
This means that the application
cannot compare the result of
<Function>tt_default_session</Function> with the result of
&cdeman.tt.message.session; to verify that the message was sent in the default session.
</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-->

66
cde/doc/C/guides/man/m3_tt/err_int.sgm Normal file
View File

@@ -0,0 +1,66 @@
<!-- $XConsortium: err_int.sgm /main/5 1996/08/30 12:45:12 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.MAN67.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN67.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_error_int</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_error_int</Function></RefName>
<RefPurpose>return an integer error object that encodes the code
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: err_int.sgm /main/5 1996/08/30 12:45:12 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_error_int</Function></FuncDef>
<ParamDef>Tt_status <Parameter>ttrc</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_error_int</Function> function
returns an integer error object that encodes a
<StructName Role="typedef">Tt_status</StructName> return value.
</Para>
<Para>The
<Emphasis>ttrc</Emphasis> argument is the
<StructName Role="typedef">Tt_status</StructName> code that is to be encoded.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_error_int</Function> function returns the encoded
<StructName Role="typedef">Tt_status</StructName> code.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The integer error objects are negative integers;
an application should use this call only when
the valid integer values are non-negative.
</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-->

59
cde/doc/C/guides/man/m3_tt/err_poin.sgm Normal file
View File

@@ -0,0 +1,59 @@
<!-- $XConsortium: err_poin.sgm /main/5 1996/08/30 12:45:23 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.MAN68.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN68.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_error_pointer</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_error_pointer</Function></RefName>
<RefPurpose>return a pointer to an error object that encodes the code
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: err_poin.sgm /main/5 1996/08/30 12:45:23 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_error_pointer</Function></FuncDef>
<ParamDef>Tt_status <Parameter>ttrc</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_error_pointer</Function> function
returns a pointer to an error object that encodes a
<StructName Role="typedef">Tt_status</StructName> return value.
</Para>
<Para>The
<Emphasis>ttrc</Emphasis> argument is the
<StructName Role="typedef">Tt_status</StructName> code that is to be encoded.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_error_pointer</Function> function returns a pointer to the encoded
<StructName Role="typedef">Tt_status</StructName> code.
</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-->

87
cde/doc/C/guides/man/m3_tt/error.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: error.sgm /main/8 1996/09/08 20:12:09 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDE.TT.tterror">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.TT.tterror">]]>
<RefMeta>
<RefEntryTitle>tt_error</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_error</Function></RefName>
<RefPurpose>capture ToolTalk function errors
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>void <Function>tt_error</Function></FuncDef>
<ParamDef>const char *<Parameter>funcname</Parameter></ParamDef>
<ParamDef>Tt_status <Parameter>status</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_error</function>
function is a publicly-known null function. It is called by
the ToolTalk library just before it returns from any ToolTalk API call
that has a status other than
<SystemItem Class="Constant">TT_OK</SystemItem>.
The caller passes the name of the function that
is about to return and the function's status code.
</Para>
<para>You can use this function to set a
<command>dbx</command> breakpoint to
quickly catch and trace back any ToolTalk errors.
You can also interpose this function, for example,
to log ToolTalk errors to <function>stderr</function>.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">funcname</symbol></Term>
<ListItem>
<Para>Specifies the name of the function.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><symbol role="Variable">status</symbol></Term>
<ListItem>
<Para>Specifies the function's return status value.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>None.</para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The following code example shows how an application might interpose this
function to log ToolTalk errors to <function>stderr</function>:
</para>
<programlisting>
void tt_error(const char *funcname, Tt_status status) {
fprintf(stderr, "ToolTalk function %s returned %s.\n",
funcname, tt_status_message(status));
}
</programlisting>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;
</para>
</RefSect1>
</RefEntry>

106
cde/doc/C/guides/man/m3_tt/fd.sgm Normal file
View File

@@ -0,0 +1,106 @@
<!-- $XConsortium: fd.sgm /main/5 1996/08/30 12:45:42 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.MAN69.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN69.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_fd</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_fd</Function></RefName>
<RefPurpose>return a file descriptor
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fd.sgm /main/5 1996/08/30 12:45:42 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>int <Function>tt_fd</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_fd</Function> function
returns a file descriptor.
The returned file descriptor alerts the process that a message has
arrived for the default
procid
in the default session.
</Para>
<Para>File descriptors are either active or inactive.
When the file descriptor becomes
active, the process must call
&cdeman.tt.message.receive; to receive the message.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_fd</Function> function returns the file descriptor for the current
procid.
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_PROCID</Term>
<ListItem>
<Para>The current default 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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application must have a separate file descriptor for each
procid.
To get an
associated file descriptor, the application should use
<Function>tt_fd</Function> each time it calls
&cdeman.tt.open;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.open;, &cdeman.tt.int.error;, &cdeman.tt.message.receive;.</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/feat_ena.sgm Normal file
View File

@@ -0,0 +1,105 @@
<!-- $XConsortium: feat_ena.sgm /main/10 1996/09/08 20:12:18 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN69a.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN69a.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_feature_enabled</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_feature_enabled</Function></RefName>
<RefPurpose>
determine if a particular feature has been enabled in this process
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_feature_enabled</Function></FuncDef>
<ParamDef>Tt_feature <Parameter>feature</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_feature_enabled</Function> function
queries the ToolTalk service to see if the specified feature has
previously been enabled.
This allows a library that "wraps around" ToolTalk for sending and receiving
messages to determine if multithreaded execution has been enabled by the
main program, and to modify its behavior accordingly.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">feature</symbol></Term>
<ListItem>
<Para>Specifies the feature whose enabled status is to be
checked.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon completion, the
<Function>tt_feature_enabled</Function> function returns
the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry><Term><SystemItem Class="Constant">TT_OK</SystemItem></Term>
<ListItem>
<Para>The feature has been enabled previously.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_WRN_NOT_ENABLED</SystemItem></Term>
<ListItem>
<Para>The feature has not yet been enabled
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_UNIMP</Term>
<ListItem>
<Para>The version of the ToolTalk library linked with the calling code does
not support the indicated feature.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>A library using ToolTalk could check to see if the
calling application had previously turned on
ToolTalk's multithreading feature with the following code:
</para>
<programlisting>
Tt_status ttstat;
ttstat = tt_feature_enabled(TT_FEATURE_MULTITHREADED);
if (ttstat != TT_OK) {
ttstat = tt_feature_required(TT_FEATURE_MULTITHREADING);
}
</programlisting>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.feature.required;
</Para>
</RefSect1>
</refentry>

110
cde/doc/C/guides/man/m3_tt/feat_req.sgm Normal file
View File

@@ -0,0 +1,110 @@
<!-- $XConsortium: feat_req.sgm /main/9 1996/09/08 20:12:26 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN69b.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN69b.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_feature_required</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_feature_required</Function></RefName>
<RefPurpose>declare a feature to be required by the calling program.
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_feature_required</Function></FuncDef>
<ParamDef>Tt_feature <Parameter>feature</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_feature_required</Function> function
declares a feature to be required by the
calling code. If the feature is available,
<Function>tt_feature_required</Function> enables it.
</para>
<para>If the feature requires the ToolTalk service to perform
some initialization (for example,
<systemitem class="constant">TT_FEATURE_MULTITHREADED</systemitem>),
the initialization is performed in this call. Some features
(such as <systemitem class="constant">TT_FEATURE_MULTITHREADED</systemitem>)
require this call to be made before calling
<function>tt_open</function>.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">feature</symbol></Term>
<ListItem>
<Para>Specifies the feature to be required.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon completion, the
<Function>tt_feature_required</Function> function returns
the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry><Term><SystemItem Class="Constant">TT_OK</SystemItem></Term>
<ListItem>
<Para>The feature is available and has been enabled.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_TOOLATE</SystemItem></Term>
<ListItem>
<Para>The <Function>tt_feature_required</Function> call must be made
prior to other calls that have already been made to the ToolTalk API.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_UNIMP</SystemItem></Term>
<ListItem>
<Para>The version of the ToolTalk library linked with the calling code does
not support the indicated feature.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>To use the ToolTalk library in a multithreaded environment, an
application would declare multithreading to be required before a call to
<function>tt_open</function> or <function>ttdt_open</function>:
</para>
<programlisting>
Tt_status ttstat;
ttstat = tt_feature_required(TT_FEATURE_MULTITHREADED);
tt_open();
</programlisting>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.feature.enabled;,
&cdeman.tt.open;,
&cdeman.ttdt.open;
</para>
</RefSect1>
</refentry>

120
cde/doc/C/guides/man/m3_tt/fil_copy.sgm Normal file
View File

@@ -0,0 +1,120 @@
<!-- $XConsortium: fil_copy.sgm /main/5 1996/08/30 12:46:11 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.MAN70.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN70.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_copy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_copy</Function></RefName>
<RefPurpose>copy objects from one file to a new file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_copy.sgm /main/5 1996/08/30 12:46:11 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_file_copy</Function></FuncDef>
<ParamDef>const char *<Parameter>oldfilepath</Parameter></ParamDef>
<ParamDef>const char *<Parameter>newfilepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_copy</Function> function
copies all objects that exist on the specified file to a new file.
If any objects already exist on
<Emphasis>newfilepath</Emphasis>, they are not overwritten by
the copy (that is, they are not removed.)
</Para>
<Para>The
<Emphasis>oldfilepath</Emphasis> argument is a pointer to the name of the file whose objects are to be copied.
The
<Emphasis>newfilepath</Emphasis> argument is a pointer to the name of the file on which to create
the copied objects.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_copy</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_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
<![ %CDE.C.CDE; [It does not appear to exist; administrative action is required.
]]></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_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory.
</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.file.move;, &cdeman.tt.file.destroy;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

124
cde/doc/C/guides/man/m3_tt/fil_dest.sgm Normal file
View File

@@ -0,0 +1,124 @@
<!-- $XConsortium: fil_dest.sgm /main/5 1996/08/30 12:46: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.MAN71.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN71.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_destroy</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_destroy</Function></RefName>
<RefPurpose>remove objected rooted on a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_dest.sgm /main/5 1996/08/30 12:46: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_file_destroy</Function></FuncDef>
<ParamDef>const char *<Parameter>filepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_destroy</Function> function
removes all objects that exist on the files and directories rooted at
<Emphasis>filepath</Emphasis>. The application must call this function when the application
unlinks a file or removes a directory.
</Para>
<Para>The
<Emphasis>filepath</Emphasis> argument is a pointer to the pathname of the file or directory to be removed.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_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_ACCESS</Term>
<ListItem>
<Para>The user does not have the necessary access to the object and/or the process.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
<![ %CDE.C.CDE; [It does not appear to exist; administrative action is required.
]]></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_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory.
</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.file.copy;, &cdeman.tt.file.move;; <![ %CDE.C.CDE; [<Function>unlink</Function>(2), <Command>rmdir</Command>(1). ]]><![ %CDE.C.XO; [<Function>unlink</Function>(2) in the &str-ZK;;
<Command>rmdir</Command>(1), in the &str-ZC;.
]]></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/fil_join.sgm Normal file
View File

@@ -0,0 +1,108 @@
<!-- $XConsortium: fil_join.sgm /main/5 1996/08/30 12:46: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.MAN72.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN72.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_join</Function></RefName>
<RefPurpose>register interest in messages involving a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_join.sgm /main/5 1996/08/30 12:46: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_file_join</Function></FuncDef>
<ParamDef>const char *<Parameter>filepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_join</Function> function
informs the ToolTalk service that the process is interested in messages
that involve the specified file.
</Para>
<Para>The ToolTalk service adds this file value to any currently registered patterns.
The named file becomes the default file.
</Para>
<Para>When the process joins a file, the ToolTalk service updates the file field
of its registered patterns.
The
<Function>tt_file_join</Function> call causes the pattern's ToolTalk
session to be stored in the database.
</Para>
<Para>The
<Emphasis>filepath</Emphasis> argument is a pointer to the pathname of the file in which the
process is interested.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_join</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_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
</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_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory.
</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-->

144
cde/doc/C/guides/man/m3_tt/fil_move.sgm Normal file
View File

@@ -0,0 +1,144 @@
<!-- $XConsortium: fil_move.sgm /main/5 1996/08/30 12:46: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.MAN73.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN73.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_move</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_move</Function></RefName>
<RefPurpose>move objects from one file to another
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_move.sgm /main/5 1996/08/30 12:46: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_file_move</Function></FuncDef>
<ParamDef>const char *<Parameter>oldfilepath</Parameter></ParamDef>
<ParamDef>const char *<Parameter>newfilepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_move</Function> function
destroys all objects that exist on the files and directories rooted at
<Emphasis>newfilepath</Emphasis>, then moves all objects that exist on
<Emphasis>oldfilepath</Emphasis> to
<Emphasis>newfilepath</Emphasis>.</Para>
<Para>If
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in the same file system,
<Function>tt_file_move</Function> replaces
<Emphasis>oldfilepath</Emphasis> with
<Emphasis>newfilepath</Emphasis> in the path associated with every object in
that file system; that is, all the objects in the directory tree rooted at
<Emphasis>oldfilepath</Emphasis> are overlaid onto
<Emphasis>newfilepath</Emphasis>. In this mode, the behavior of
<Function>tt_file_move</Function> is similar to
<Function>rename</Function>(2).</Para>
<Para>If
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in different file systems, neither can be a directory.
</Para>
<Para>The
<Emphasis>oldfilepath</Emphasis> argument is the name of the file or directory whose objects are to be moved.
The
<Emphasis>newfilepath</Emphasis> argument is the name of the file or directory to which the objects
are to be moved.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_move</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_ACCESS</Term>
<ListItem>
<Para>The user does not have the necessary access to the object and/or the process.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
</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_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory,
or
<Emphasis>oldfilepath</Emphasis> and
<Emphasis>newfilepath</Emphasis> reside in different file systems, and either is a directory.
</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.file.copy;, &cdeman.tt.file.destroy;; <![ %CDE.C.CDE; [<Function>rename</Function>(2). ]]><![ %CDE.C.XO; [<Function>rename</Function>(2) in the &str-ZK;.
]]></Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

114
cde/doc/C/guides/man/m3_tt/fil_netf.sgm Normal file
View File

@@ -0,0 +1,114 @@
<!-- $XConsortium: fil_netf.sgm /main/7 1996/09/08 20:12: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.MAN74.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN74.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_netfile</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_netfile</Function></RefName>
<RefPurpose>map between local and canonical pathnames on the local host
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_netf.sgm /main/7 1996/09/08 20:12:34 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_file_netfile</Function></FuncDef>
<ParamDef>const char *<Parameter>filename</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_netfile</Function> function converts a local pathname to a
<Emphasis>netfilename</Emphasis>, a form that can be passed to other hosts on the network and converted
back to a local pathname for the same file with
&cdeman.tt.netfile.file;.</Para>
<Para>The
<Symbol Role="Variable">filename</Symbol> argument is
a pathname (absolute or relative) that is valid on the local host.
Every component of
<Symbol Role="Variable">filename</Symbol> must exist, except that the last component need not exist.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_netfile</Function> function returns
a freshly allocated
null-terminated string of unspecified format, which can be passed to
&cdeman.tt.netfile.file; or
&cdeman.tt.host.netfile.file;; otherwise, it returns an error pointer.
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_ERR_PATH</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">filename</Symbol> argument is a path that is not valid on this host.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile; and
&cdeman.tt.host.netfile.file; functions allow an
application to determine a path valid on remote hosts,
perhaps for purposes of constructing a command string valid for remote
execution on that host.
By composing the two calls, paths for files not accessible from the
current host can be constructed.
For example, if path
<Filename>/sample/file</Filename> is valid on host A, a program
running on host B can use
</Para>
<InformalExample Remap="indent">
<ProgramListing>tt_host_netfile_file("C", tt_host_file_netfile("A", "/sample/file"))
</ProgramListing>
</InformalExample>
<Para>to determine a path to the same file valid on host C, if such a
path is possible.
</Para>
<Para>The
<Emphasis>netfile</Emphasis> string
returned by
<Function>tt_file_netfile</Function> should be considered opaque;
the content and format of the strings are not a public interface.
These strings can be safely copied (with
<Function>strcpy</Function>3C or similar methods), written to files, or transmitted
to other processes, perhaps on other hosts.
</Para>
<Para>Allocated strings should be freed using either
&cdeman.tt.free; or
&cdeman.tt.release;.</Para>
<Para>The
&cdeman.tt.open; function need not be called before
<Function>tt_file_netfile</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile;, &cdeman.tt.host.netfile.file;, &cdeman.tt.open;, &cdeman.tt.free;, &cdeman.tt.release;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

148
cde/doc/C/guides/man/m3_tt/fil_ob_q.sgm Normal file
View File

@@ -0,0 +1,148 @@
<!-- $XConsortium: fil_ob_q.sgm /main/5 1996/08/30 12:46: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.MAN75.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN75.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_objects_query</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_objects_query</Function></RefName>
<RefPurpose>find all objects in the named file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_ob_q.sgm /main/5 1996/08/30 12:46: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>Tt_status <Function>tt_file_objects_query</Function></FuncDef>
<ParamDef>const char *<Parameter>filepath</Parameter></ParamDef>
<ParamDef>Tt_filter_function <Parameter>filter</Parameter></ParamDef>
<ParamDef>void *<Parameter>context</Parameter></ParamDef>
<ParamDef>void *<Parameter>accumulator</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_objects_query</Function> function instructs the ToolTalk service to find all objects in the
named file and pass the
objids
to the filter function.
The context pointer and accumulator pointer initially specified are also
passed to the filter function.
</Para>
<Para>As the ToolTalk service finds each object,
it calls the filter function, passing the
objid
of the object and the two application-supplied pointers.
The filter function performs its computation and returns a
<StructName Role="typedef">Tt_filter_action</StructName> value that tells the query function whether to continue or to stop.
<StructName Role="typedef">Tt_filter_action</StructName> values are:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_FILTER_CONTINUE</Term>
<ListItem>
<Para>The query function should continue.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_FILTER_STOP</Term>
<ListItem>
<Para>The query function should stop.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The
<Emphasis>filepath</Emphasis> argument is the name of the file to be searched for objects.
The
<Emphasis>filter</Emphasis> argument is the filter function to which the
objids
are to be passed.
The
<Symbol Role="Variable">context</Symbol> argument is a pointer to any information the filter needs to execute.
The ToolTalk service does not interpret this argument,
but passes it directly to the filter function.
The
<Emphasis>accumulator</Emphasis> argument is a pointer to where the filter is to store the results
of the query and filter operations.
The ToolTalk service does not interpret this argument, but passes
it directly to the filter function.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_objects_query</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_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
</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_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_WRN_STOPPED</Term>
<ListItem>
<Para>The query operation being performed was halted by
<StructName Role="typedef">Tt_filter_function</StructName>.</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/fil_quit.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: fil_quit.sgm /main/5 1996/08/30 12:47: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.MAN76.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN76.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_file_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_file_quit</Function></RefName>
<RefPurpose>register lack of interest in messages that involve a file
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: fil_quit.sgm /main/5 1996/08/30 12:47: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_file_quit</Function></FuncDef>
<ParamDef>const char *<Parameter>filepath</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_file_quit</Function> function
informs the ToolTalk service that the process is no longer interested in
messages that involve the specified file.
</Para>
<Para>The ToolTalk service removes this file value from any currently registered
patterns and sets the default file to
<SystemItem Class="Constant">NULL</SystemItem>.</Para>
<Para>The
<Emphasis>filepath</Emphasis> argument is the name of the file in which the process is no longer interested.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_file_quit</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_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk service could not access the
ToolTalk database needed for this operation.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk service could not access the
specified ToolTalk database in the expected place.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PATH</Term>
<ListItem>
<Para>The specified pathname included an unsearchable directory.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.default.file;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

68
cde/doc/C/guides/man/m3_tt/free.sgm Normal file
View File

@@ -0,0 +1,68 @@
<!-- $XConsortium: free.sgm /main/5 1996/08/30 12:47:17 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.MAN77.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN77.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_free</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_free</Function></RefName>
<RefPurpose>free storage from the ToolTalk API allocation stack
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: free.sgm /main/5 1996/08/30 12:47:17 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_free</Function></FuncDef>
<ParamDef>caddr_t <Parameter>p</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_free</Function> function
frees storage from the ToolTalk API allocation stack.
</Para>
<Para>The
<Emphasis>p</Emphasis> argument is the
address of the storage in the ToolTalk API allocation stack to be freed.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>tt_free</Function> function returns no value.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should use the
<Function>tt_free</Function> function instead of
&cdeman.tt.mark; and
&cdeman.tt.release; if, for
example, the process is in a loop
(that is, it obtains strings from the ToolTalk service
and processes each in turn).
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.malloc;, &cdeman.tt.mark;, &cdeman.tt.release;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

134
cde/doc/C/guides/man/m3_tt/h_f_netf.sgm Normal file
View File

@@ -0,0 +1,134 @@
<!-- $XConsortium: h_f_netf.sgm /main/7 1996/09/08 20:12: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.MAN78.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN78.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_host_file_netfile</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_host_file_netfile</Function></RefName>
<RefPurpose>map between local and canonical pathnames on a remote host
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: h_f_netf.sgm /main/7 1996/09/08 20:12:43 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_host_file_netfile</Function></FuncDef>
<ParamDef>const char *<Parameter>host</Parameter></ParamDef>
<ParamDef>const char *<Parameter>filename</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_host_file_netfile</Function> function performs a conversion equivalent to that of the
&cdeman.tt.file.netfile; function, but performs it on a remote host.
</Para>
<Para>The
<Symbol Role="Variable">filename</Symbol> argument is
a pathname (absolute or relative) that is valid on the remote host.
Every component of
<Symbol Role="Variable">filename</Symbol> must exist, except for the last component.
The
<Symbol Role="Variable">host</Symbol> argument is a name of a remote host.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_host_file_netfile</Function> function returns
a freshly allocated
null-terminated string of unspecified format, which can be passed to
&cdeman.tt.netfile.file; or
&cdeman.tt.host.netfile.file;; otherwise, it returns an error pointer.
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_ERR_PATH</Term>
<ListItem>
<Para>The
<Symbol Role="Variable">filename</Symbol> argument is a path that is not valid on
the remote host.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk database server
could not be reached on
<Symbol Role="Variable">host</Symbol>, perhaps because the host is unavailable or
cannot be reached through the network.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk database server
is not properly installed on
<Symbol Role="Variable">host</Symbol>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_UNIMP</Term>
<ListItem>
<Para>The ToolTalk database server
contacted is of a version that does not support
<Function>tt_host_file_netfile</Function>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile; and
&cdeman.tt.host.netfile.file; functions allow an
application to determine a path valid on remote hosts,
perhaps for purposes of constructing a command string valid for remote
execution on that host.
By composing the two calls, paths for files not accessible from the
current host can be constructed.
For example, if path
<Filename>/sample/file</Filename> is valid on host A, a program
running on host B can use
</Para>
<InformalExample Remap="indent">
<ProgramListing>tt_host_netfile_file("C", tt_host_file_netfile("A", "/sample/file"))
</ProgramListing>
</InformalExample>
<Para>to determine a path to the same file valid on host C, if such a
path is possible.
</Para>
<Para>Allocated strings should be freed using either
&cdeman.tt.free; or
&cdeman.tt.release;.</Para>
<Para>The
&cdeman.tt.open; function need not be called before
<Function>tt_host_file_netfile</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.netfile.file;, &cdeman.tt.open;, &cdeman.tt.free;, &cdeman.tt.release;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

131
cde/doc/C/guides/man/m3_tt/h_netf_f.sgm Normal file
View File

@@ -0,0 +1,131 @@
<!-- $XConsortium: h_netf_f.sgm /main/7 1996/09/08 20:12: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.MAN79.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN79.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_host_netfile_file</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_host_netfile_file</Function></RefName>
<RefPurpose>map between canonical and local pathnames on a remote host
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: h_netf_f.sgm /main/7 1996/09/08 20:12: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>char <Function>*tt_host_netfile_file</Function></FuncDef>
<ParamDef>const char *<Parameter>host</Parameter></ParamDef>
<ParamDef>const char *<Parameter>netfilename</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_host_netfile_file</Function> function performs a conversion equivalent to that of the
&cdeman.tt.netfile.file; function, but performs it on a remote host.
</Para>
<Para>The
<Symbol Role="Variable">host</Symbol> argument
is the host on which the file resides.
The
<Emphasis>netfilename</Emphasis> argument is a copy of a null-terminated string returned by
&cdeman.tt.netfile.file; or
&cdeman.tt.host.netfile.file;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_host_netfile_file</Function> function returns
a freshly allocated
null-terminated string of unspecified format, which can be passed to
&cdeman.tt.host.netfile.file;; otherwise, it returns an error pointer.
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_ERR_DBAVAIL</Term>
<ListItem>
<Para>The ToolTalk database server
could not be reached on
<Symbol Role="Variable">host</Symbol>, perhaps because the host is unavailable or
cannot be reached through the network.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_DBEXIST</Term>
<ListItem>
<Para>The ToolTalk database server
is not properly installed on
<Symbol Role="Variable">host</Symbol>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NETFILE</Term>
<ListItem>
<Para>The
<Emphasis>netfilename</Emphasis> is not a valid netfilename.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_UNIMP</Term>
<ListItem>
<Para>The ToolTalk database server
contacted is of a version that does not support
<Function>tt_host_netfile_file</Function>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile; and
&cdeman.tt.host.netfile.file; functions allow an
application to determine a path valid on remote hosts,
perhaps for purposes of constructing a command string valid for remote
execution on that host.
By composing the two calls, paths for files not accessible from the
current host can be constructed.
For example, if path
<Filename>/sample/file</Filename> is valid on host A, a program
running on host B can use
</Para>
<InformalExample Remap="indent">
<ProgramListing>tt_host_netfile_file("C", tt_host_file_netfile("A", "/sample/file"))
</ProgramListing>
</InformalExample>
<Para>to determine a path to the same file valid on host C, if such a
path is possible.
</Para>
<Para>Allocated strings should be freed using either
&cdeman.tt.free; or
&cdeman.tt.release;.</Para>
<Para>The
&cdeman.tt.open; function need not be called before
<Function>tt_host_netfile_file</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile;, &cdeman.tt.open;, &cdeman.tt.free;, &cdeman.tt.release;.</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/ico_join.sgm Normal file
View File

@@ -0,0 +1,92 @@
<!-- $XConsortium: ico_join.sgm /main/5 1996/08/30 12:47: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.MAN80.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN80.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_icontext_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_icontext_join</Function></RefName>
<RefPurpose>add an integer value to the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: ico_join.sgm /main/5 1996/08/30 12:47: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_icontext_join</Function></FuncDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>int <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_icontext_join</Function> function
adds the given integer value to the list of values for the contexts of all
patterns.
</Para>
<Para>The context is compared to currently registered patterns for the
procid.
If a
pattern has a slot with the specified name,
the given integer value is added to
the list of values for that slot.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
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_icontext_join</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_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/ico_quit.sgm Normal file
View File

@@ -0,0 +1,93 @@
<!-- $XConsortium: ico_quit.sgm /main/5 1996/08/30 12:47:55 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.MAN81.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN81.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_icontext_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_icontext_quit</Function></RefName>
<RefPurpose>remove an integer value from the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: ico_quit.sgm /main/5 1996/08/30 12:47:55 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_icontext_quit</Function></FuncDef>
<ParamDef>const char *<Parameter>slotname</Parameter></ParamDef>
<ParamDef>int <Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_icontext_quit</Function> function
removes the given integer value from the list of values for the
contexts of all patterns.
</Para>
<Para>The context is compared to currently registered patterns for the
procid.
If a
pattern has a slot with the specified name, the given integer value is removed
from the list of values for that slot.
</Para>
<Para>If there are duplicate values, only one value is removed.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument is the name of the context.
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_icontext_quit</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_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-->

85
cde/doc/C/guides/man/m3_tt/init_ses.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: init_ses.sgm /main/5 1996/08/30 12:48: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.MAN82.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN82.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_initial_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_initial_session</Function></RefName>
<RefPurpose>return the initial session identifier
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: init_ses.sgm /main/5 1996/08/30 12:48: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>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tt_initial_session</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_initial_session</Function> function
returns the initial session identifier of the
&cdeman.ttsession; with which the current
process identifier is associated.
</Para>
<Para>The current
process identifier is obtained by calling
&cdeman.tt.open;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_initial_session</Function> function returns the identifier for the current ToolTalk session.
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>
</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.open;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

58
cde/doc/C/guides/man/m3_tt/int_err.sgm Normal file
View File

@@ -0,0 +1,58 @@
<!-- $XConsortium: int_err.sgm /main/5 1996/08/30 12:48: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.MAN83.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN83.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_int_error</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_int_error</Function></RefName>
<RefPurpose>return the status of an error object
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: int_err.sgm /main/5 1996/08/30 12:48: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_int_error</Function></FuncDef>
<ParamDef>int <Parameter>return_val</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_int_error</Function> function returns the status of an error object.
</Para>
<Para>The
<Emphasis>return_val</Emphasis> argument is the integer returned by a ToolTalk function.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_int_error</Function> function returns either
<SystemItem Class="Constant">TT_OK</SystemItem>, if the integer is not an
error object, or the encoded
<StructName Role="typedef">Tt_status</StructName> value if the integer is an error object.
</Para>
</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-->

72
cde/doc/C/guides/man/m3_tt/is_err.sgm Normal file
View File

@@ -0,0 +1,72 @@
<!-- $XConsortium: is_err.sgm /main/5 1996/08/30 12:48:23 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.MAN84.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN84.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_is_err</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><SystemItem Class="Constant">tt_is_err</SystemItem></RefName>
<RefPurpose>check status value
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: is_err.sgm /main/5 1996/08/30 12:48:23 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>
<Synopsis>#include &lt;Tt/tt_c.h>
int tt_is_err(Tt_status <Symbol Role="Variable">s</Symbol>);
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_is_err</Function> function
checks whether a status value is a warning or an error.
</Para>
<Para>The
<Symbol Role="Variable">s</Symbol> argument is the
<StructName Role="typedef">Tt_status</StructName> code to check.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_is_err</Function> function returns one of the following integers:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>The
<StructName Role="typedef">Tt_status</StructName> is either a warning or
<SystemItem Class="Constant">TT_OK</SystemItem>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>1</Term>
<ListItem>
<Para>The
<StructName Role="typedef">Tt_status</StructName> is an error.
</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-->

67
cde/doc/C/guides/man/m3_tt/malloc.sgm Normal file
View File

@@ -0,0 +1,67 @@
<!-- $XConsortium: malloc.sgm /main/5 1996/08/30 12:48:33 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.MAN85.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN85.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_malloc</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_malloc</Function></RefName>
<RefPurpose>allocate storage on the ToolTalk API allocation stack
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: malloc.sgm /main/5 1996/08/30 12:48:33 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>caddr_t <Function>tt_malloc</Function></FuncDef>
<ParamDef>size_t <Parameter>s</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_malloc</Function> function
allocates storage on the ToolTalk API allocation stack.
</Para>
<Para>The
<Symbol Role="Variable">s</Symbol> argument is the amount of storage to be allocated in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_malloc</Function> function returns
the address of the storage in the ToolTalk API
allocation stack that is to be allocated.
If
<SystemItem Class="Constant">NULL</SystemItem> is returned, no storage is available.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>This function allows the application-provided callback routines to take
advantage of the allocation stack; for example, a query filter function can
allocate storage to accumulate a result.
</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-->

54
cde/doc/C/guides/man/m3_tt/mark.sgm Normal file
View File

@@ -0,0 +1,54 @@
<!-- $XConsortium: mark.sgm /main/5 1996/08/30 12:48: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.MAN86.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN86.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_mark</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_mark</Function></RefName>
<RefPurpose>mark a storage position in the ToolTalk API allocation stack
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: mark.sgm /main/5 1996/08/30 12:48:43 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>int <Function>tt_mark</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_mark</Function> function
marks a storage position in the ToolTalk API allocation stack.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_mark</Function> function returns an
integer that marks the storage position in the ToolTalk API allocation stack.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.release;.</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/netf_fil.sgm Normal file
View File

@@ -0,0 +1,127 @@
<!-- $XConsortium: netf_fil.sgm /main/7 1996/09/08 20:13:01 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.MAN162.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN162.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_netfile_file</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_netfile_file</Function></RefName>
<RefPurpose>map between canonical and local pathnames on the local host
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: netf_fil.sgm /main/7 1996/09/08 20:13:01 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_netfile_file</Function></FuncDef>
<ParamDef>const char *<Parameter>netfilename</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_netfile_file</Function> function
converts a
<Emphasis>netfilename</Emphasis> of the format returned by
&cdeman.tt.file.netfile; to a pathname that is valid on the local host.
If the file
is not currently mounted on the local host,
<Function>tt_netfile_file</Function> constructs a pathname of the form:
</Para>
<InformalExample Remap="indent">
<ProgramListing>/<Emphasis>mountpoint</Emphasis>/<Symbol Role="Variable">host</Symbol>/<Emphasis>filepath</Emphasis></ProgramListing>
</InformalExample>
<Para>where
<Emphasis>mountpoint</Emphasis> is the mount point pathname in
the environment variable
<Emphasis>DTMOUNTPOINT</Emphasis>, or
<Filename>/net</Filename> if the variable is null or unset.
</Para>
<Para>The
<Emphasis>netfilename</Emphasis> argument is a copy of a null-terminated string returned by
&cdeman.tt.netfile.file; or
&cdeman.tt.host.netfile.file;.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_netfile_file</Function> function returns
a null-terminated local filename;
otherwise, it returns an error pointer.
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_ERR_NETFILE</Term>
<ListItem>
<Para>The
<Emphasis>netfilename</Emphasis> argument
is not a valid netfilename.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The
&cdeman.tt.file.netfile;, &cdeman.tt.netfile.file;, &cdeman.tt.host.file.netfile; and
&cdeman.tt.host.netfile.file; functions allow an
application to determine a path valid on remote hosts,
perhaps for purposes of constructing a command string valid for remote
execution on that host.
By composing the two calls, paths for files not accessible from the
current host can be constructed.
For example, if path
<Filename>/sample/file</Filename> is valid on host A, a program
running on host B can use
</Para>
<InformalExample Remap="indent">
<ProgramListing>tt_host_netfile_file("C", tt_host_file_netfile("A", "/sample/file"))
</ProgramListing>
</InformalExample>
<Para>to determine a path to the same file valid on host C, if such a
path is possible.
</Para>
<Para>The
<Emphasis>netfilename</Emphasis> string input to
<Function>tt_netfile_file</Function> should be considered opaque;
the content and format of the strings are not a public interface.
These strings can be safely copied (with
<Function>strcpy</Function>3C or similar methods), written to files, or transmitted
to other processes, perhaps on other hosts.
</Para>
<Para>The
<Emphasis>mountpoint</Emphasis> value is intended to be the mount point for the automounter's host map
on those systems supporting automounting services.
</Para>
<Para>Allocated strings should be freed using either
&cdeman.tt.free; or
&cdeman.tt.release;.</Para>
<Para>The
&cdeman.tt.open; function need not be called before
<Function>tt_netfile_file</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.file.netfile;, &cdeman.tt.host.file.netfile;, &cdeman.tt.host.netfile.file;, &cdeman.tt.open;, &cdeman.tt.free;, &cdeman.tt.release;.</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/objid_eq.sgm Normal file
View File

@@ -0,0 +1,126 @@
<!-- $XConsortium: objid_eq.sgm /main/5 1996/08/30 12:49:01 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.MAN163.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN163.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_objid_equal</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_objid_equal</Function></RefName>
<RefPurpose>test whether two objids are equal
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: objid_eq.sgm /main/5 1996/08/30 12:49:01 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_objid_equal</Function></FuncDef>
<ParamDef>const char *<Parameter>objid1</Parameter></ParamDef>
<ParamDef>const char *<Parameter>objid2</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_objid_equal</Function> function
tests whether two
objids
are equal.
</Para>
<Para>The
&cdeman.tt.objid.equal; function is recommended rather than
<Function>strcmp</Function>(3) for this purpose because the
&cdeman.tt.objid.equal; function returns 1 even in the
case where one
objid
is a forwarding pointer for the other.
</Para>
<Para>The
<Emphasis>objid1</Emphasis> argument is the identifier of the first object involved in this operation.
The
<Emphasis>objid2</Emphasis> argument is the identifier of the second object involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_objid_equal</Function> function returns an integer that indicates whether the
objids
are equal.
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>0</Term>
<ListItem>
<Para>The
<Emphasis>objid1</Emphasis> and
<Emphasis>objid2</Emphasis> objects are not equal.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>1</Term>
<ListItem>
<Para>The
<Emphasis>objid1</Emphasis> and
<Emphasis>objid2</Emphasis> objects are equal.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The application can use
&cdeman.tt.int.error; to determine if the integer is valid.
The
<Function>tt_objid_equal</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_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.int.error;.</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/objid_ob.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: objid_ob.sgm /main/5 1996/08/30 12:49: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.MAN164.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN164.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_objid_objkey</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_objid_objkey</Function></RefName>
<RefPurpose>return the unique key of an objid
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: objid_ob.sgm /main/5 1996/08/30 12:49: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>char <Function>*tt_objid_objkey</Function></FuncDef>
<ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_objid_objkey</Function> function
returns the unique key of an
objid.
</Para>
<Para>The
<Emphasis>objid</Emphasis> argument is the identifier of the object involved in this operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_objid_objkey</Function> function returns the unique key of the
<Emphasis>objid</Emphasis>. No two
objids
have the same unique key.
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_OBJID</Term>
<ListItem>
<Para>The
<Emphasis>objid</Emphasis> passed to the ToolTalk service does not reference an existing object spec.
</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/onot_cre.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: onot_cre.sgm /main/5 1996/08/30 12:49: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.MAN165.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN165.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_onotice_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_onotice_create</Function></RefName>
<RefPurpose>create a notice
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: onot_cre.sgm /main/5 1996/08/30 12:49: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_message <Function>tt_onotice_create</Function></FuncDef>
<ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>op</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_onotice_create</Function> function
creates a message.
The created message contains the following:
</Para>
<Para><StructName Role="typedef">Tt_address</StructName> =
<SystemItem Class="Constant">TT_OBJECT</SystemItem> <StructName Role="typedef">Tt_class</StructName> =
<SystemItem Class="Constant">TT_NOTICE</SystemItem></Para>
<Para><![ %CDE.C.XO; []]>The application can use the returned handle to add
arguments and other attributes, and to send the message.
</Para>
<Para>The
<Emphasis>objid</Emphasis> argument is the identifier of the specified object.
The
<Symbol Role="Variable">op</Symbol> argument is the operation to be performed by the receiving process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_onotice_create</Function> function returns the unique handle that identifies the 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_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 specified process identifier is out of date or 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-->

114
cde/doc/C/guides/man/m3_tt/open.sgm Normal file
View File

@@ -0,0 +1,114 @@
<!-- $XConsortium: open.sgm /main/6 1996/09/08 20:13: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.MAN166.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN166.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_open</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_open</Function></RefName>
<RefPurpose>return the process identifier for the calling process
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: open.sgm /main/6 1996/09/08 20:13: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>
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tt_open</Function></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_open</Function> function
returns the process identifier for the calling process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>tt_open</Function> function also sets this identifier as the default
procid
for the process.
The
&cdeman.tt.open; function is typically the first ToolTalk function called by a process.
</Para>
<Para>The application must call
&cdeman.tt.open; before other
<Emphasis>tt_</Emphasis> calls are made.
However, there are two exceptions:
&cdeman.tt.default.session.set; and
&cdeman.tt.X.session; can be called before
<Function>tt_open</Function>.</Para>
<Para>A process can call
<Function>tt_open</Function> more than once to obtain multiple
procids.
To open another session, the process must
make the following calls in the order specified:
</Para>
<InformalExample Remap="indent">
<ProgramListing><Function>tt_default_session_set</Function>
<Function>tt_open</Function></ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_open</Function> function returns the character value that uniquely identifies the 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>
</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>Each
procid
has its own associated file descriptor, and can join another session.
To switch to another
procid,
the application should call
<Function>tt_default_procid_set</Function>.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.fd;, &cdeman.tt.default.procid;, &cdeman.tt.default.procid.set;, &cdeman.tt.default.session;, &cdeman.tt.default.session.set;, &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/oreq_cre.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: oreq_cre.sgm /main/5 1996/08/30 12:49:38 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.MAN167.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN167.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_orequest_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_orequest_create</Function></RefName>
<RefPurpose>create a request message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: oreq_cre.sgm /main/5 1996/08/30 12:49:38 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_orequest_create</Function></FuncDef>
<ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>op</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_orequest_create</Function> function
creates a message.
The created message contains the following:
</Para>
<Para><StructName Role="typedef">Tt_address</StructName> =
<SystemItem Class="Constant">TT_OBJECT</SystemItem> <StructName Role="typedef">Tt_class</StructName> =
<SystemItem Class="Constant">TT_REQUEST</SystemItem></Para>
<Para><![ %CDE.C.XO; []]>The application can use the returned handle to add
arguments and other attributes, and to send the message.
</Para>
<Para>The
<Emphasis>objid</Emphasis> argument is the identifier of the specified object.
The
<Symbol Role="Variable">op</Symbol> argument is the operation to be performed by the receiving process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_orequest_create</Function> function returns the unique handle that identifies the 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_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 specified process identifier is out of date or 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-->

138
cde/doc/C/guides/man/m3_tt/pnot_cre.sgm Normal file
View File

@@ -0,0 +1,138 @@
<!-- $XConsortium: pnot_cre.sgm /main/5 1996/08/30 12:49: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.MAN214.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN214.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_pnotice_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_pnotice_create</Function></RefName>
<RefPurpose>create a procedure notice
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pnot_cre.sgm /main/5 1996/08/30 12:49:49 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_pnotice_create</Function></FuncDef>
<ParamDef>Tt_scope <Parameter>scope</Parameter></ParamDef>
<ParamDef>const char *<Parameter>op</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_pnotice_create</Function> function creates a message.
The created message contains the following:
</Para>
<Para><StructName Role="typedef">Tt_address</StructName> =
<SystemItem Class="Constant">TT_PROCEDURE</SystemItem> <StructName Role="typedef">Tt_class</StructName> =
<SystemItem Class="Constant">TT_NOTICE</SystemItem></Para>
<Para><![ %CDE.C.XO; []]>The application can use the returned handle to add
arguments and other attributes, and to send the message.
</Para>
<Para>The
<Emphasis>scope</Emphasis> argument determines which processes are 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
<Symbol Role="Variable">op</Symbol> argument is the operation to be performed by the receiving process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_pnotice_create</Function> function returns the unique handle that identifies 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 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 specified process identifier is out of date or 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>
<Para>If the ToolTalk service is unable to create a message when requested,
<Function>tt_pnotice_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.ptr.error;, &cdeman.tt.free;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

89
cde/doc/C/guides/man/m3_tt/poin_err.sgm Normal file
View File

@@ -0,0 +1,89 @@
<!-- $XConsortium: poin_err.sgm /main/5 1996/08/30 12:49: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.MAN215.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN215.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_pointer_error</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_pointer_error</Function></RefName>
<RefPurpose>return the status of a pointer
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: poin_err.sgm /main/5 1996/08/30 12:49: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_pointer_error</Function></FuncDef>
<ParamDef>void *<Parameter>pointer</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_pointer_error</Function> function
returns the status of the specified pointer.
</Para>
<Para>If an opaque pointer
(<StructName Role="typedef">Tt_message</StructName> or
<StructName Role="typedef">Tt_pattern</StructName>) or character pointer
<Literal>(char *)</Literal> is specified, this function returns
<SystemItem Class="Constant">TT_OK</SystemItem> if the pointer is valid or the encoded
<StructName Role="typedef">Tt_status</StructName> value if the pointer is an error object.
</Para>
<Para>The
<Symbol Role="Variable">pointer</Symbol> argument is the opaque pointer or character pointer to be checked.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_pointer_error</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.ptr.error;, &cdeman.tt.ptr.error;.</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/pr_sess.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: pr_sess.sgm /main/9 1996/09/08 20:13:18 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN215a.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN215a.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_procid_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_procid_session</Function></RefName>
<RefPurpose>
identify the session in which a procid was opened
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>const char *<Function>tt_procid_session</Function></FuncDef>
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_procid_session</Function> function
returns the identifier of the session in which the
specified procid was opened.
</para>
<para>The return value points to the sessid for the session associated with
the procid. When the sessid value is no longer needed, it
must be freed with <function>tt_free</function>.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">procid</symbol></Term>
<ListItem>
<Para>The identifier for the procid for which the session
identifier is to be returned.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_procid_session</Function> function returns
the pointer to the session identifier.
</Para>
<VariableList>
<VarListEntry>
<Term><systemitem class="constant">TT_OK</systemitem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_NOMP</systemitem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running
and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_PROCID</systemitem></Term>
<ListItem>
<Para>The specified process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.free;,
&cdeman.tt.error.pointer;
</Para>
</RefSect1>
</refentry>

138
cde/doc/C/guides/man/m3_tt/preq_cre.sgm Normal file
View File

@@ -0,0 +1,138 @@
<!-- $XConsortium: preq_cre.sgm /main/5 1996/08/30 12:50: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.MAN216.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN216.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_prequest_create</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_prequest_create</Function></RefName>
<RefPurpose>create a procedure request message
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: preq_cre.sgm /main/5 1996/08/30 12:50: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_message <Function>tt_prequest_create</Function></FuncDef>
<ParamDef>Tt_scope <Parameter>scope</Parameter></ParamDef>
<ParamDef>const char *<Parameter>op</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_prequest_create</Function> function creates a message.
The created message created contains the following:
</Para>
<Para><StructName Role="typedef">Tt_address</StructName> =
<SystemItem Class="Constant">TT_PROCEDURE</SystemItem> <StructName Role="typedef">Tt_class</StructName> =
<SystemItem Class="Constant">TT_REQUEST</SystemItem></Para>
<Para><![ %CDE.C.XO; []]>The application can use the returned handle to add
arguments and other attributes, and to send the message.
</Para>
<Para>The
<Emphasis>scope</Emphasis> argument determines which processes are 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
<Symbol Role="Variable">op</Symbol> argument is the operation to be performed by the receiving process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_prequest_create</Function> function returns the unique handle that identifies 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 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 specified process identifier is out of date or 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>
<Para>If the ToolTalk service is unable to create a message when requested,
<Function>tt_prequest_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.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/pt_o_c_a.sgm Normal file
View File

@@ -0,0 +1,112 @@
<!-- $XConsortium: pt_o_c_a.sgm /main/5 1996/08/30 12:50: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.MAN220.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN220.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_ptype_opnum_callback_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_ptype_opnum_callback_add</Function></RefName>
<RefPurpose>return a callback if two opnums are equal
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pt_o_c_a.sgm /main/5 1996/08/30 12:50: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_ptype_opnum_callback_add</Function></FuncDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
<ParamDef>int <Parameter>opnum</Parameter></ParamDef>
<ParamDef>Tt_message_callback <Parameter>f</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_ptype_opnum_callback_add</Function> function
returns a callback if the specified opnums are equal.
The callback is defined in
&cdeman.Tt.tt.c.h;.</Para>
<Para>When a message is delivered because it matched a pattern derived from a
signature in the named
ptype
with an opnum equal to the specified one, the
given callback is run in the usual ToolTalk way.
</Para>
<Para>The
<Emphasis>ptid</Emphasis> argument is the identifier of the ptype involved in this operation.
The
<Emphasis>opnum</Emphasis> argument is the opnum of the specified ptype.
The
<Emphasis>f</Emphasis> argument is the message callback to be run.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_ptype_opnum_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_PTYPE</Term>
<ListItem>
<Para>The specified process type is not the name of an installed process 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>
<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>The
<Function>tt_ptype_opnum_callback_add</Function> function will only be called for messages
delivered by virtue of matching handler signatures.
The callback cannot be called for observer signatures
because the observer ptype is not recorded in the
incoming message.
</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-->

74
cde/doc/C/guides/man/m3_tt/ptr_err.sgm Normal file
View File

@@ -0,0 +1,74 @@
<!-- $XConsortium: ptr_err.sgm /main/7 1996/08/30 12:50:38 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.MAN217.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN217.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_ptr_error</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><SystemItem Class="Constant">tt_ptr_error</SystemItem></RefName>
<RefPurpose>pointer error macro
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_ptr_error</Function></FuncDef>
<ParamDef><Parameter>pointer</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_ptr_error</Function> macro expands to
<Literal>tt_pointer_error((void *)(p))</Literal>.</Para>
<Para>The
<Symbol Role="Variable">pointer</Symbol> argument is the opaque pointer or character pointer to be checked.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_ptr_error</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.ptr.error;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

82
cde/doc/C/guides/man/m3_tt/pty_decl.sgm Normal file
View File

@@ -0,0 +1,82 @@
<!-- $XConsortium: pty_decl.sgm /main/5 1996/08/30 12:50:48 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.MAN218.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN218.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_ptype_declare</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_ptype_declare</Function></RefName>
<RefPurpose>register the process type with the ToolTalk service
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pty_decl.sgm /main/5 1996/08/30 12:50:48 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_ptype_declare</Function></FuncDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_ptype_declare</Function> function
registers the process type with the ToolTalk service.
</Para>
<Para>The
<Emphasis>ptid</Emphasis> argument is the character string specified in the
ptype that uniquely identifies this process.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_ptype_declare</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_PTYPE</Term>
<ListItem>
<Para>The specified process type is not the name of an installed process type.
</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-->

85
cde/doc/C/guides/man/m3_tt/pty_exis.sgm Normal file
View File

@@ -0,0 +1,85 @@
<!-- $XConsortium: pty_exis.sgm /main/5 1996/08/30 12:50: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.MAN219.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN219.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_ptype_exists</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_ptype_exists</Function></RefName>
<RefPurpose>indicate whether a ptype is already installed
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pty_exis.sgm /main/5 1996/08/30 12:50: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_ptype_exists</Function></FuncDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_ptype_exists</Function> function
returns an indication of whether a
ptype
is already installed.
</Para>
<Para>The
<Emphasis>ptid</Emphasis> argument is the character string specifying the ptype.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_ptype_exists</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 and the
ptype
is already installed.
</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_PTYPE</Term>
<ListItem>
<Para>The specified process type is not the name of an installed process type.
</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-->

86
cde/doc/C/guides/man/m3_tt/pty_unde.sgm Normal file
View File

@@ -0,0 +1,86 @@
<!-- $XConsortium: pty_unde.sgm /main/5 1996/08/30 12:51: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.MAN221.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN221.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_ptype_undeclare</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_ptype_undeclare</Function></RefName>
<RefPurpose>undeclare a ptype
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: pty_unde.sgm /main/5 1996/08/30 12:51: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_ptype_undeclare</Function></FuncDef>
<ParamDef>const char *<Parameter>ptid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_ptype_undeclare</Function> function
undeclares the indicated
ptype
and unregisters the patterns associated with the indicated
ptype
from the ToolTalk service.
</Para>
<Para>The
<Emphasis>ptid</Emphasis> argument is the character string specifying the
ptype.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_ptype_undeclare</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_PTYPE</Term>
<ListItem>
<Para>The specified process type is not the name of an installed process type.
</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/release.sgm Normal file
View File

@@ -0,0 +1,62 @@
<!-- $XConsortium: release.sgm /main/5 1996/08/30 12:51: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.MAN222.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN222.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_release</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_release</Function></RefName>
<RefPurpose>free storage allocated on the ToolTalk API allocation stack
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: release.sgm /main/5 1996/08/30 12:51: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>void <Function>tt_release</Function></FuncDef>
<ParamDef>int <Parameter>mark</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_release</Function> function
frees all storage allocated on the ToolTalk API allocation stack
since
<Emphasis>mark</Emphasis> was returned by
&cdeman.tt.mark;.</Para>
<Para>The
<Emphasis>mark</Emphasis> argument is an
integer that marks the application's storage position in the ToolTalk API
allocation stack.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>This function frees all storage allocated since the
&cdeman.tt.mark; call that returned
<Emphasis>mark</Emphasis> and is typically called at the end of a procedure to release all
storage allocated within the procedure.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.mark;.</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/status_m.sgm Normal file
View File

@@ -0,0 +1,84 @@
<!-- $XConsortium: status_m.sgm /main/5 1996/08/30 12:51: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.MAN251.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN251.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_status_message</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_status_message</Function></RefName>
<RefPurpose>provide a message for a problem status code
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: status_m.sgm /main/5 1996/08/30 12:51: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>char <Function>*tt_status_message</Function></FuncDef>
<ParamDef>Tt_status <Parameter>ttrc</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_status_message</Function> function
returns a pointer to a message that describes the problem indicated by this
status code.
</Para>
<Para>The
<Emphasis>ttrc</Emphasis> argument is the status code received during an operation.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_status_message</Function> function returns a pointer to a
character string that describes the status code,
which is 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_xxx</Term>
<ListItem>
<Para>Any other
<SystemItem Class="Constant">TT_</SystemItem> status code is explained in the returned string.
</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-->

104
cde/doc/C/guides/man/m3_tt/thr_pr_s.sgm Normal file
View File

@@ -0,0 +1,104 @@
<!-- $XConsortium: thr_pr_s.sgm /main/8 1996/08/30 12:51:39 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN251a.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN251a.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_thread_procid_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_thread_procid_set</Function></RefName>
<RefPurpose>
set the default procid for the currently active thread
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_thread_procid_set</Function></FuncDef>
<ParamDef>const char *<Parameter>procid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_thread_procid_set</Function> function
sets the default procid for the currently active thread.
The default procid is an implicit argument to most ToolTalk API calls.
</Para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">procid</symbol></Term>
<ListItem>
<Para>Specifies the name of the procid that is to be
the default procid for the current thread.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon completion, the
<Function>tt_thread_procid_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><SystemItem Class="Constant">TT_OK</SystemItem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_NOMP</SystemItem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running and
the ToolTalk service cannot start it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_PROCID</SystemItem></Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_UNIMP</SystemItem></Term>
<ListItem>
<Para>The ToolTalk implementation does not support multithreading.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_TOOLATE</SystemItem></Term>
<ListItem>
<Para>The multithreading feature has not been enabled.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.open;
</Para>
</RefSect1>
</refentry>

91
cde/doc/C/guides/man/m3_tt/thr_proc.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: thr_proc.sgm /main/7 1996/09/08 20:13:27 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDE.TT.ttthreadprocid">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.TT.ttthreadprocid">]]>
<RefMeta>
<RefEntryTitle>tt_thread_procid</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_thread_procid</Function></RefName>
<RefPurpose>
identify the default process for the currently active thread
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char *<Function>tt_thread_procid</Function></FuncDef>
<ParamDef></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_thread_procid</Function> function
returns the current default procid for the currently-active thread.
</para>
<para>If there is no default procid set for the thread, then the process
default procid is returned.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<para>None.
</para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_thread_procid</Function> function returns
the pointer to a character string that uniquely identifies the default
process for the currently active thread. 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><systemitem class="constant">TT_OK</systemitem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_NOMP</systemitem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running
and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_PROCID</systemitem></Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should 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.free;,
&cdeman.tt.ptr.error;
</Para>
</RefSect1>
</RefEntry>

143
cde/doc/C/guides/man/m3_tt/thr_se_s.sgm Normal file
View File

@@ -0,0 +1,143 @@
<!-- $XConsortium: thr_se_s.sgm /main/8 1996/08/30 12:51:58 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN251b.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN251b.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_thread_session_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_thread_session_set</Function></RefName>
<RefPurpose>set the default session identifier for the current thread
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_thread_session_set</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_thread_session_set</Function> function
sets the default session identifier
for the currently active thread. The ToolTalk service uses the initial
user session as the default session and supports one session per
procid. The application can make this call before it calls
<function>tt_open</function> to specify which session
it wants to connect to in the active thread.
</para>
<para>To change to another opened session, the application must use either
<function>tt_thread_procid_set</function> or
<function>tt_default_procid_set</function>.
</para>
<para>To join other sessions, the procid must first set the new session as
the default session, and then initialize and register with the
ToolTalk service. The calls required must be in the following order:
<function>tt_thread_session_set</function> or
<function>tt_default_session_set</function> and
then <function>tt_open</function>.
</para>
<para>The <function>tt_open</function> call may create another
ToolTalk procid, the connection to which is identified by a procid.
Only one ToolTalk session per procid is allowed. (However, multiple procids
are allowed in a client.)
</para>
<para>There are no API calls to determine the session to which a procid
is connected. If it is important for the application to know the
session to which it is connected, it must make the following calls
in the indicated order: <function>tt_open</function> and then
<function>tt_thread_session</function>.
</Para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<VariableList>
<VarListEntry>
<Term><symbol role="Variable">sessid</symbol></Term>
<ListItem>
<Para>Specifies a pointer to the unique identifier string
for the session that is to be the default session for the current thread.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_thread_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><SystemItem Class="Constant">TT_OK</SystemItem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_NOMP</SystemItem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running and
the ToolTalk service cannot start it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_PROCID</SystemItem></Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_SESSION</SystemItem></Term>
<ListItem>
<Para>The specified ToolTalk session is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_UNIMP</SystemItem></Term>
<ListItem>
<Para>The ToolTalk implementation does not support multithreading.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry><Term><SystemItem Class="Constant">TT_ERR_TOOLATE</SystemItem></Term>
<ListItem>
<Para>The multithreading feature has not been enabled.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>Some ToolTalk API calls implicitly depend on the current default
session. Setting the default session for the specific thread prevents
race conditions caused by other threads changing the global default
session.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.default.procid;,
&cdeman.tt.default.session;,
&cdeman.tt.feature.required;,
&cdeman.tt.thread.procid;,
&cdeman.tt.thread.session;
</Para>
</RefSect1>
</refentry>

114
cde/doc/C/guides/man/m3_tt/thr_sess.sgm Normal file
View File

@@ -0,0 +1,114 @@
<!-- $XConsortium: thr_sess.sgm /main/9 1996/09/08 20:13:36 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE;[<Refentry Id="CDEMX.XCDI.MAN251c.rsml.1">]]>
<![%CDE.C.XO;[<Refentry Id="XCDI.MAN251c.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_thread_session</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_thread_session</Function></RefName>
<RefPurpose>
retrieve the default session identifier for the currently active thread
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char *<Function>tt_thread_session</Function></FuncDef>
<ParamDef></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_thread_session</Function> function
retrieves the default session
identifier for the currently active thread. If there is no default
session set for the currently-active thread, then the process default
session identifier is returned.
</para>
<para>A session can have more than one session identifier.
This means, for example, that the application cannot compare the
result of <function>tt_thread_session</function> with the result of
<function>tt_message_session</function> to verify that the message was
sent in the default session.
</Para>
<para>The returned pointer points to the character string name of
the session. When no longer needed, it must be
freed with <function>tt_free</function>.
</para>
</RefSect1>
<RefSect1>
<Title>ARGUMENTS</Title>
<Para>None.</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<para>Upon successful completion, the
<Function>tt_thread_session</Function> function returns
the pointer to a character string that uniquely identifies the default
session for the currently active thread.
</para>
<VariableList>
<VarListEntry>
<Term><systemitem class="constant">TT_OK</systemitem></Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarlistEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_NOMP</systemitem></Term>
<ListItem>
<Para>The <command>ttsession</command> process is not running
and the ToolTalk service cannot start it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_PROCID</systemitem></Term>
<ListItem>
<Para>The current default process identifier is out of date or invalid.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_UNIMP</systemitem></Term>
<ListItem>
<Para>The ToolTalk implementation does not support multithreading.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><systemitem class="constant">TT_ERR_TOOLATE</systemitem></Term>
<ListItem>
<Para>The multithreading feature has not been enabled.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;,
&cdeman.tt.free;,
&cdeman.tt.ptr.error;
</Para>
</RefSect1>
</refentry>

87
cde/doc/C/guides/man/m3_tt/trace_co.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: trace_co.sgm /main/5 1996/08/30 12:52: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.MAN252.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN252.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_trace_control</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_trace_control</Function></RefName>
<RefPurpose>control client-side tracing
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: trace_co.sgm /main/5 1996/08/30 12:52: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>int <Function>tt_trace_control</Function></FuncDef>
<ParamDef>int <Parameter>onoff</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_trace_control</Function> function
sets or clears an internal flag controlling all client-side tracing.
The intent of this is to be called from debugger breakpoints,
allowing a programmer to narrow the trace to the suspect area.
</Para>
<Para>The value of the
<Emphasis>onoff</Emphasis> argument affects tracing as follows:
</Para>
<VariableList>
<VarListEntry>
<Term>&numsp;0</Term>
<ListItem>
<Para>Tracing is turned off.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&numsp;1</Term>
<ListItem>
<Para>Tracing is turned on.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;1</Term>
<ListItem>
<Para>Tracing is turned on if it was off and vice-versa.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>tt_trace_control</Function> function returns the previous setting of the trace flag.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>This call does not return one of the
<SystemItem Class="Constant">TT_xxx</SystemItem> type of errors or warnings, but only the numbers 1 or zero.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.ttsession;.</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/xco_join.sgm Normal file
View File

@@ -0,0 +1,91 @@
<!-- $XConsortium: xco_join.sgm /main/8 1996/08/30 12:52: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.MAN160.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN160.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_xcontext_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_xcontext_join</Function></RefName>
<RefPurpose>add an XDR-interpreted byte-array to the list of values
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_xcontext_join</Function></FuncDef>
<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_xcontext_join</Function> function
adds the given XDR-interpreted byte-array value to the list of values for the
named contexts of all patterns.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument describes the slotname in this message.
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_xcontext_join</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_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-->

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

@@ -0,0 +1,92 @@
<!-- $XConsortium: xco_quit.sgm /main/7 1996/08/30 12:52:38 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.MAN253.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN253.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_xcontext_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_xcontext_quit</Function></RefName>
<RefPurpose>remove an XDR-interpreted byte-array value from the list of values
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_xcontext_quit</Function></FuncDef>
<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_xcontext_quit</Function> function
removes the given XDR-interpreted byte-array value from the list of values
for the contexts of all patterns.
</Para>
<Para>The
<Emphasis>slotname</Emphasis> argument describes the slotname in this message.
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>.</Para>
<Para>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_xcontext_quit</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_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-->