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

102
cde/doc/C/guides/man/m3_tt_session/bpro_add.sgm Normal file
View File

@@ -0,0 +1,102 @@
<!-- $XConsortium: bpro_add.sgm /main/5 1996/08/30 13:46:57 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN224.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN224.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_bprop_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_bprop_add</Function></RefName>
<RefPurpose>add a new byte-string value to the end of the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bpro_add.sgm /main/5 1996/08/30 13:46:57 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_session_bprop_add</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</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_session_bprop_add</Function> function
adds a new byte-string value to the end of the list of values for the named
property of the specified session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property to which to add values.
The
<Symbol Role="Variable">value</Symbol> argument is the value to add to the session property.
The
<Symbol Role="Variable">length</Symbol> argument is the size of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_bprop_add</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPLEN</Term>
<ListItem>
<Para>The specified property value is too long.
(The maximum size is implementation specific, but is at least 2048.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name 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-->

112
cde/doc/C/guides/man/m3_tt_session/bpro_set.sgm Normal file
View File

@@ -0,0 +1,112 @@
<!-- $XConsortium: bpro_set.sgm /main/5 1996/08/30 13:47: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.MAN225.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN225.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_bprop_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_bprop_set</Function></RefName>
<RefPurpose>replace current values stored under the named property of a session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bpro_set.sgm /main/5 1996/08/30 13:47: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_session_bprop_set</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</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_session_bprop_set</Function> function
replaces any current values stored under the named property of the
specified session with the given byte-string value.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property whose value is to be replaced.
The
<Symbol Role="Variable">value</Symbol> argument is the value to which the session property is set.
If value is
<SystemItem Class="Constant">NULL</SystemItem>, the property
is removed entirely.
The
<Symbol Role="Variable">length</Symbol> argument is the size of the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_bprop_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_PROPLEN</Term>
<ListItem>
<Para>The specified property value is too long.
(The maximum size is implementation specific, but is at least 2048.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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>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-->

127
cde/doc/C/guides/man/m3_tt_session/bprop.sgm Normal file
View File

@@ -0,0 +1,127 @@
<!-- $XConsortium: bprop.sgm /main/5 1996/08/30 13:47:25 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN223.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN223.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_bprop</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_bprop</Function></RefName>
<RefPurpose>retrieve the ith value of the named property of a session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bprop.sgm /main/5 1996/08/30 13:47:25 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_session_bprop</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
<ParamDef>int <Parameter>i</Parameter></ParamDef>
<ParamDef>unsigned char **<Parameter>value</Parameter></ParamDef>
<ParamDef>int *<Parameter>length</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_bprop</Function> function
retrieves the
<Symbol Role="Variable">i</Symbol>th value of the named property of the specified session.
</Para>
<Para>If there are
<Symbol Role="Variable">i</Symbol> values or fewer, both the returned value and the returned length
are set to zero.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property from which values are to be obtained.
The
<Symbol Role="Variable">i</Symbol> argument is the number of the item in the property list from which the value is to be
obtained.
The list numbering begins with zero.
The
<Symbol Role="Variable">value</Symbol> argument is the
address of a character pointer to which the ToolTalk service is to point a
string that contains the contents of the property.
The
<Emphasis>len</Emphasis> argument is the address of an integer to which the ToolTalk service is to set the length of
the value in bytes.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_bprop</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_NOMEM</Term>
<ListItem>
<Para>There is insufficient memory available to perform the function.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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>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-->

81
cde/doc/C/guides/man/m3_tt_session/join.sgm Normal file
View File

@@ -0,0 +1,81 @@
<!-- $XConsortium: join.sgm /main/5 1996/08/30 13:47: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.MAN226.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN226.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_join</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_join</Function></RefName>
<RefPurpose>join a session and make it the default
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: join.sgm /main/5 1996/08/30 13:47: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_status <Function>tt_session_join</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_join</Function> function
joins the named session and makes it the default session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session to join.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_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>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application can use the
<Emphasis>sessid</Emphasis> value returned by
&cdeman.tt.default.session;, &cdeman.tt.X.session;, or
&cdeman.tt.initial.session;.</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.X.session;, &cdeman.tt.default.session;, &cdeman.tt.initial.session;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

125
cde/doc/C/guides/man/m3_tt_session/prop.sgm Normal file
View File

@@ -0,0 +1,125 @@
<!-- $XConsortium: prop.sgm /main/5 1996/08/30 13:47: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.MAN227.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN227.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_prop</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_prop</Function></RefName>
<RefPurpose>return the ith value of a session property
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: prop.sgm /main/5 1996/08/30 13:47: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_session_prop</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
<ParamDef>int <Parameter>i</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_prop</Function> function
returns the
<Symbol Role="Variable">i</Symbol>th value of the specified session property.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property from which a value is to be retrieved.
The name
must be less than 64 bytes.
The
<Symbol Role="Variable">i</Symbol> argument is the number of the item in the property name list
for which the value is to be obtained.
The list numbering begins with zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_prop</Function> function returns the value of the requested property.
If there are
<Symbol Role="Variable">i</Symbol> values or fewer, it returns
<SystemItem Class="Constant">NULL</SystemItem>. The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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 should use
&cdeman.tt.free; to free any data stored in the address returned by the
ToolTalk API.
</Para>
<Para>If the returned value has embedded nulls, it is
impossible to determine how long it is.
The application can use
&cdeman.tt.session.bprop; for values with embedded nulls.
</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-->

108
cde/doc/C/guides/man/m3_tt_session/prop_add.sgm Normal file
View File

@@ -0,0 +1,108 @@
<!-- $XConsortium: prop_add.sgm /main/5 1996/08/30 13:47: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.MAN228.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN228.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_prop_add</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_prop_add</Function></RefName>
<RefPurpose>add a new character-string value to the end of the list of values
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: prop_add.sgm /main/5 1996/08/30 13:47: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_session_prop_add</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_prop_add</Function> function
adds a new character-string value to the end of the list of values for the
property of the specified session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property to which a value is to be added.
The name must
be less than 64 bytes.
The
<Symbol Role="Variable">value</Symbol> argument is the character string to add to the property name list.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_prop_add</Function> function returns the status of the operation as one of the following
<StructName Role="typedef">Tt_status</StructName> values:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPLEN</Term>
<ListItem>
<Para>The specified property value is too long.
(The maximum size is implementation specific, but is at least 64.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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>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-->

97
cde/doc/C/guides/man/m3_tt_session/prop_cnt.sgm Normal file
View File

@@ -0,0 +1,97 @@
<!-- $XConsortium: prop_cnt.sgm /main/5 1996/08/30 13:48: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.MAN229.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN229.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_prop_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_prop_count</Function></RefName>
<RefPurpose>return the number of values stored under a property of a session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: prop_cnt.sgm /main/5 1996/08/30 13:48: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>int <Function>tt_session_prop_count</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_prop_count</Function> function
returns the number of values stored under the named property of the
specified session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property to be examined.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_prop_count</Function> function returns the number of values in the specified property list.
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_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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>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-->

107
cde/doc/C/guides/man/m3_tt_session/prop_set.sgm Normal file
View File

@@ -0,0 +1,107 @@
<!-- $XConsortium: prop_set.sgm /main/5 1996/08/30 13: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.MAN230.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN230.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_prop_set</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_prop_set</Function></RefName>
<RefPurpose>replace current values for a property of a session with a character-string value
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: prop_set.sgm /main/5 1996/08/30 13: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>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_session_prop_set</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
<ParamDef>const char *<Parameter>value</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_prop_set</Function> function
replaces all current values stored under the named property of the specified
session with the given character-string value.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Emphasis>propname</Emphasis> argument is the name of the property to be examined.
The
<Symbol Role="Variable">value</Symbol> argument is the new value to be inserted.
<SystemItem Class="Constant">NULL</SystemItem> removes a value from the property list.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_prop_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_PROPLEN</Term>
<ListItem>
<Para>The specified property value is too long.
(The maximum size is implementation specific, but is at least 64.)
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_PROPNAME</Term>
<ListItem>
<Para>The specified property name is syntactically 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>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_session/propna_c.sgm Normal file
View File

@@ -0,0 +1,86 @@
<!-- $XConsortium: propna_c.sgm /main/5 1996/08/30 13:48:35 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN232.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN232.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_propnames_count</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_propnames_count</Function></RefName>
<RefPurpose>return the number of property names for the session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: propna_c.sgm /main/5 1996/08/30 13:48:35 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>tt_session_propnames_count</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_propnames_count</Function> function
returns the number of currently defined property names for the session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_propnames_count</Function> function returns the number of property names for the session.
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_SESSION</Term>
<ListItem>
<Para>The specified ToolTalk session is out of date or invalid.
</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-->

111
cde/doc/C/guides/man/m3_tt_session/propname.sgm Normal file
View File

@@ -0,0 +1,111 @@
<!-- $XConsortium: propname.sgm /main/5 1996/08/30 13:48: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.MAN231.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN231.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_propname</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_propname</Function></RefName>
<RefPurpose>returns an element of the list of property names for a session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: propname.sgm /main/5 1996/08/30 13:48: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>char <Function>*tt_session_propname</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_propname</Function> function
returns the
<Symbol Role="Variable">n</Symbol>th element of the list of currently defined property names for
the specified session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session joined.
The application can use the
<Emphasis>sessid</Emphasis> value returned when
<Function>tt_default_session</Function> is called.
The
<Symbol Role="Variable">n</Symbol> argument is the number of the item in the property name list for which a name is to be
obtained.
The list numbering begins with zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_propname</Function> function returns the name of the specified property
from the session property list.
If there are
<Symbol Role="Variable">n</Symbol> properties or fewer,
<Function>tt_session_propname</Function> returns
<SystemItem Class="Constant">NULL</SystemItem>. The application can use
&cdeman.tt.ptr.error; to extract one of the following
<StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
</Para>
<VariableList>
<VarListEntry>
<Term>TT_OK</Term>
<ListItem>
<Para>The operation completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NOMP</Term>
<ListItem>
<Para>The
&cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>TT_ERR_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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 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_session/quit.sgm Normal file
View File

@@ -0,0 +1,83 @@
<!-- $XConsortium: quit.sgm /main/5 1996/08/30 13:49: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.MAN233.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN233.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_quit</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_quit</Function></RefName>
<RefPurpose>quit the session
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: quit.sgm /main/5 1996/08/30 13:49: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_session_quit</Function></FuncDef>
<ParamDef>const char *<Parameter>sessid</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_quit</Function> function
informs the ToolTalk service that the process is no longer interested in this
ToolTalk session.
The ToolTalk service stops delivering messages scoped to this session.
</Para>
<Para>The
<Emphasis>sessid</Emphasis> argument is the name of the session to quit.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_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_SESSION</Term>
<ListItem>
<Para>The specified ToolTalk session 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_session/types_ld.sgm Normal file
View File

@@ -0,0 +1,98 @@
<!-- $XConsortium: types_ld.sgm /main/5 1996/08/30 13:49:16 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN234.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN234.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_session_types_load</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_session_types_load</Function></RefName>
<RefPurpose>merge a compiled ToolTalk types file into the running ttsession
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: types_ld.sgm /main/5 1996/08/30 13:49:16 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>Tt_status <Function>tt_session_types_load</Function></FuncDef>
<ParamDef>const char *<Parameter>session</Parameter></ParamDef>
<ParamDef>const char *<Parameter>filename</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_session_types_load</Function> function
merges a compiled ToolTalk types file into the running
&cdeman.ttsession;.</Para>
<Para>The
<Emphasis>session</Emphasis> argument is the name of the running session.
The
<Symbol Role="Variable">filename</Symbol> argument is the name of the compiled ToolTalk types file.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_session_types_load</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_SESSION</Term>
<ListItem>
<Para>The specified ToolTalk session 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>
<VarListEntry>
<Term>TT_ERR_UNIMP</Term>
<ListItem>
<Para>The ToolTalk function called is not implemented.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</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-->