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

<!-- $XConsortium: bprop.sgm /main/5 1996/08/30 15:20:40 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.MAN235.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN235.rsml.1">]]>
<RefMeta>
<RefEntryTitle>tt_spec_bprop</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>tt_spec_bprop</Function></RefName>
<RefPurpose>retrieve the ith value of a property
</RefPurpose>
</RefNameDiv>
<!-- $XConsortium: bprop.sgm /main/5 1996/08/30 15:20:40 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_spec_bprop</Function></FuncDef>
<ParamDef>const char *<Parameter>objid</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_spec_bprop</Function> function
retrieves the
<Symbol Role="Variable">i</Symbol>th value of the specified property.
</Para>
<Para>The
<Emphasis>objid</Emphasis> argument is the identifier of the object involved in this operation.
The
<Emphasis>propname</Emphasis> argument is the name of the property whose value is to be retrieved.
The name must be
less than 64 characters.
The
<Symbol Role="Variable">i</Symbol> argument is the item of the list for which a 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 spec's property.
If there are
<Symbol Role="Variable">i</Symbol> values
or fewer, the pointer is set to zero.
The
<Symbol Role="Variable">length</Symbol> 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_spec_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_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>
<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-->