126 lines
4.0 KiB
Plaintext
126 lines
4.0 KiB
Plaintext
<!-- $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 <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-->
|