1 <!-- $XConsortium: prop.sgm /main/5 1996/08/30 15:22:40 rws $ -->
2 <!-- (c) Copyright 1995 Digital Equipment Corporation. -->
3 <!-- (c) Copyright 1995 Hewlett-Packard Company. -->
4 <!-- (c) Copyright 1995 International Business Machines Corp. -->
5 <!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
6 <!-- (c) Copyright 1995 Novell, Inc. -->
7 <!-- (c) Copyright 1995 FUJITSU LIMITED. -->
8 <!-- (c) Copyright 1995 Hitachi. -->
10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN242.rsml.1">]]>
11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN242.rsml.1">]]>
13 <RefEntryTitle>tt_spec_prop</RefEntryTitle>
14 <ManVolNum>library call</ManVolNum>
17 <RefName><Function>tt_spec_prop</Function></RefName>
18 <RefPurpose>retrieve the ith value of the property associated with an object spec
21 <!-- $XConsortium: prop.sgm /main/5 1996/08/30 15:22:40 rws $-->
22 <!-- CDE Common Source Format, Version 1.0.0-->
23 <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
24 <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
25 <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
26 <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
28 <FuncSynopsis Remap="ANSI">
29 <FuncSynopsisInfo>#include <Tt/tt_c.h>
31 <FuncDef>char <Function>*tt_spec_prop</Function></FuncDef>
32 <ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
33 <ParamDef>const char *<Parameter>propname</Parameter></ParamDef>
34 <ParamDef>int <Parameter>i</Parameter></ParamDef>
38 <Title>DESCRIPTION</Title>
40 <Function>tt_spec_prop</Function> function
42 <Symbol Role="Variable">i</Symbol>th value of the property associated with this object spec.
45 <Emphasis>objid</Emphasis> argument is the identifier of the object involved in this operation.
47 <Emphasis>propname</Emphasis> argument is the name of the property associated with the object spec.
49 <Symbol Role="Variable">i</Symbol> argument is the item of the list whose value is to be retrieved.
50 The list numbering begins with zero.
54 <Title>RETURN VALUE</Title>
55 <Para>Upon successful completion, the
56 <Function>tt_spec_prop</Function> function returns the contents of the property value.
58 <Symbol Role="Variable">i</Symbol> values or less,
59 <Function>tt_spec_prop</Function> returns
60 <SystemItem Class="Constant">NULL</SystemItem>. The application can use
61 &cdeman.tt.ptr.error; to extract one of the following
62 <StructName Role="typedef">Tt_status</StructName> values from the returned pointer:
68 <Para>The operation completed successfully.
73 <Term>TT_ERR_DBAVAIL</Term>
75 <Para>The ToolTalk service could not access the
76 ToolTalk database needed for this operation.
81 <Term>TT_ERR_DBEXIST</Term>
83 <Para>The ToolTalk service could not access the
84 specified ToolTalk database in the expected place.
89 <Term>TT_ERR_NOMP</Term>
92 &cdeman.ttsession; process is not running and the ToolTalk service cannot restart it.
97 <Term>TT_ERR_NUM</Term>
99 <Para>The integer value passed was invalid (out of range).
104 <Term>TT_ERR_OBJID</Term>
107 <Emphasis>objid</Emphasis> passed to the ToolTalk service does not reference an existing object spec.
112 <Term>TT_ERR_PROPNAME</Term>
114 <Para>The specified property name is syntactically invalid.
121 <Title>APPLICATION USAGE</Title>
122 <Para>The application should use
123 &cdeman.tt.free; to free any data stored in the address returned by the
126 <Para>If the returned value has embedded nulls, its length cannot be determined.
130 <Title>SEE ALSO</Title>
131 <Para>&cdeman.Tt.tt.c.h;, &cdeman.tt.ptr.error;, &cdeman.tt.free;.</Para>
134 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->