CDE/cde/doc/C/guides/man/m3_tt_spec/propname.sgm

<!-- $XConsortium: propname.sgm /main/5 1996/08/30 15:24:56 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN246.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN246.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_spec_propname</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_spec_propname</Function></RefName>
<RefPurpose>return an element of the property name list for an object spec
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: propname.sgm /main/5 1996/08/30 15:24:56 rws $-->
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<FuncSynopsis Remap="ANSI">
<FuncSynopsisInfo>#include &lt;Tt/tt_c.h>
</FuncSynopsisInfo>
<FuncDef>char <Function>*tt_spec_propname</Function></FuncDef>
<ParamDef>const char *<Parameter>objid</Parameter></ParamDef>
<ParamDef>int <Parameter>n</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>tt_spec_propname</Function> function
returns the
<Symbol Role="Variable">n</Symbol>th element of the property name list for this object spec.
</Para>
<Para>The
<Emphasis>objid</Emphasis> argument is the identifier of the object involved in this operation.
The
<Symbol Role="Variable">n</Symbol> argument is the item of the list whose element is to be returned.
The list numbering
begins with zero.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>tt_spec_propname</Function> function returns the property name.
If there are
<Symbol Role="Variable">n</Symbol> properties or less,
<Function>tt_spec_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_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_NUM</Term>
<ListItem>
<Para>The integer value passed was invalid (out of range).
</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-->