CDE/cde/doc/C/guides/man/m3_DtDts/DaTToAtL.sgm

<!-- $XConsortium: DaTToAtL.sgm /main/5 1996/08/30 13:18:53 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.MAN33.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN33.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtDtsDataTypeToAttributeList</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtDtsDataTypeToAttributeList</Function></RefName>
<RefPurpose>get a list of attributes for a data type
</RefPurpose>
</RefNameDiv>
<!-- 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;Dt/Dts.h>
</FuncSynopsisInfo>
<FuncDef>DtDtsAttribute <Function>**DtDtsDataTypeToAttributeList</Function></FuncDef>
<ParamDef>const char *<Parameter>datatype</Parameter></ParamDef>
<ParamDef>const char *<Parameter>opt_name</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtDtsDataTypeToAttributeList</Function> function returns a list of attributes for a data type.
</Para>
<Para>The
<Emphasis>datatype</Emphasis> argument is a pointer to a data type name string.
</Para>
<Para>The
<Emphasis>opt_name</Emphasis> argument can be used to specify a name to be associated with the
data type.
If the
<Emphasis>opt_name</Emphasis> argument is not
<SystemItem Class="Constant">NULL</SystemItem>, it is used as a pseudo file name in typing;
otherwise, certain attributes may be returned as
<SystemItem Class="Constant">NULL</SystemItem> because the filename components could not be determined.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtDtsDataTypeToAttributeList</Function> function returns a
<SystemItem Class="Constant">NULL</SystemItem>-terminated array of pointers of
<Literal>*DtDtsAttribute</Literal>, or
<SystemItem Class="Constant">NULL</SystemItem> if no value could be determined.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>The application should use the
&cdeman.DtDtsFreeAttributeList; function to release the memory for the returned value.
</Para>
<Para>The
<Emphasis>opt_name</Emphasis> argument is useful when the attribute being returned
contains a modifier string that depends on having
a file name included.
For example, if the
<SystemItem Class="Constant">INSTANCE_ICON</SystemItem> attribute had the value
<Literal>%name%.icon</Literal>, <Emphasis>opt_name</Emphasis> would be used to derive the
<Literal>%name%</Literal> portion of the attribute value.
See
<![ %CDE.C.CDE; [&cdeman.dtdtsfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.M4DTS.anch.6" Role="4">. ]]></Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Filename Role="Header">Dt/Dts.h</Filename>, &cdeman.DtDtsLoadDataTypes;, &cdeman.DtDtsFreeAttributeList;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->