Initial import of the CDE 2.1.30 sources from the Open Group.
[oweals/cde.git] / cde / doc / C / guides / man / man5 / DtDts.sgm
1 <!-- $XConsortium: DtDts.sgm /main/6 1996/09/08 19:58:55 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. -->
9
10 <![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN322.rsml.1">]]>
11 <![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN322.rsml.1">]]>
12 <RefMeta>
13 <RefEntryTitle>Dt/Dts.h</RefEntryTitle>
14 <ManVolNum>file formats</ManVolNum>
15 </RefMeta>
16 <RefNameDiv>
17 <RefName><Filename>Dt/Dts.h</Filename></RefName>
18 <RefPurpose>data typing definitions
19 </RefPurpose>
20 </RefNameDiv>
21 <!-- CDE Common Source Format, Version 1.0.0-->
22 <!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
23 <!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
24 <!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
25 <!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
26 <RefSynopsisDiv>
27 <Synopsis>#include &lt;Dt/Dts.h>
28 </Synopsis>
29 </RefSynopsisDiv>
30 <RefSect1>
31 <Title>DESCRIPTION</Title>
32 <Para>The
33 <Filename Role="Header">Dt/Dts.h</Filename> header declares the following structure:
34 </Para>
35 <InformalExample Remap="indent">
36 <ProgramListing>typedef struct  _DtDtsAttribute {
37         char    *<Symbol Role="Variable">name</Symbol>;
38         char    *<Symbol Role="Variable">value</Symbol>;
39 } DtDtsAttribute;
40 </ProgramListing>
41 </InformalExample>
42 <Para>The header declares the following as functions:
43 </Para>
44 <Synopsis>DtDtsAttribute **DtDtsBufferToAttributeList(const void *<Symbol Role="Variable">buffer</Symbol>,
45         const int <Symbol Role="Variable">size</Symbol>,
46         const char *<Emphasis>opt_name</Emphasis>);
47 </Synopsis>
48 <Synopsis>char *DtDtsBufferToAttributeValue(const void *<Symbol Role="Variable">buffer</Symbol>,
49         const int <Symbol Role="Variable">size</Symbol>,
50         const char *<Emphasis>attr_name</Emphasis>,
51         const char *<Emphasis>opt_name</Emphasis>);
52 </Synopsis>
53 <Synopsis>char *DtDtsBufferToDataType(const void *<Symbol Role="Variable">buffer</Symbol>,
54         const int <Symbol Role="Variable">size</Symbol>,
55         const char *<Emphasis>opt_name</Emphasis>);
56 </Synopsis>
57 <Synopsis>char *DtDtsDataToDataType(const char *<Emphasis>filepath</Emphasis>,
58         const void *<Symbol Role="Variable">buffer</Symbol>,
59         const int <Symbol Role="Variable">size</Symbol>,
60         const struct stat *<Emphasis>stat_buff</Emphasis>,
61         const char *<Emphasis>link_path</Emphasis>,
62         const struct stat *<Emphasis>link_stat_buff</Emphasis>,
63         const char *<Emphasis>opt_name</Emphasis>);
64 </Synopsis>
65 <Synopsis>int DtDtsDataTypeIsAction(const char *<Emphasis>datatype</Emphasis>);
66 </Synopsis>
67 <Synopsis>char **DtDtsDataTypeNames(void);
68 </Synopsis>
69 <Synopsis>DtDtsAttribute **DtDtsDataTypeToAttributeList(const char *<Emphasis>datatype</Emphasis>,
70         const char *<Emphasis>opt_name</Emphasis>);
71 </Synopsis>
72 <Synopsis>char *DtDtsDataTypeToAttributeValue(const char *<Emphasis>datatype</Emphasis>,
73         const char *<Emphasis>attr_name</Emphasis>,
74         const char *<Emphasis>opt_name</Emphasis>);
75 </Synopsis>
76 <Synopsis>DtDtsAttribute **DtDtsFileToAttributeList(const char *<Emphasis>filepath</Emphasis>);
77 </Synopsis>
78 <Synopsis>char *DtDtsFileToAttributeValue(const char *<Emphasis>filepath</Emphasis>,
79         const char *<Emphasis>attr_name</Emphasis>);
80 </Synopsis>
81 <Synopsis>char *DtDtsFileToDataType(const char *<Emphasis>filepath</Emphasis>);
82 </Synopsis>
83 <Synopsis>char **DtDtsFindAttribute(const char *<Emphasis>attr_name</Emphasis>,
84         const char *<Emphasis>attr_value</Emphasis>);
85 </Synopsis>
86 <Synopsis>void DtDtsFreeAttributeList(DtDtsAttribute **<Emphasis>attr_list</Emphasis>);
87 </Synopsis>
88 <Synopsis>void DtDtsFreeAttributeValue(char *<Emphasis>attr_value</Emphasis>);
89 </Synopsis>
90 <Synopsis>void DtDtsFreeDataType(char *<Emphasis>datatype</Emphasis>);
91 </Synopsis>
92 <Synopsis>void DtDtsFreeDataTypeNames(char **<Emphasis>namelist</Emphasis>);
93 </Synopsis>
94 <Synopsis>void DtDtsLoadDataTypes(void);
95 </Synopsis>
96 <Synopsis>void DtDtsRelease(void);
97 </Synopsis>
98 <Synopsis>char *DtDtsSetDataType(const char *<Emphasis>dirpath</Emphasis>,
99         const char *<Emphasis>datatype</Emphasis>,
100         const int <Emphasis>override</Emphasis>);
101 </Synopsis>
102 </RefSect1>
103 </RefEntry>
104 <!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->