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

<!-- $XConsortium: SetDaT.sgm /main/5 1996/08/30 13:21:55 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.MAN46.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN46.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtDtsSetDataType</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtDtsSetDataType</Function></RefName>
<RefPurpose>set the data type of a directory
</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>char <Function>*DtDtsSetDataType</Function></FuncDef>
<ParamDef>const char *<Parameter>dirpath</Parameter></ParamDef>
<ParamDef>const char *<Parameter>datatype</Parameter></ParamDef>
<ParamDef>const int <Parameter>override</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtDtsSetDataType</Function> function sets the data type of a directory.
This may be accomplished by adding a file
named with a leading dot to the directory.
</Para>
<Para>The
<Emphasis>dirpath</Emphasis> argument is a pathname of the directory.
</Para>
<Para>The
<Emphasis>datatype</Emphasis> argument is a data type.
</Para>
<Para>If the value is already set,
<Function>DtDtsSetDataType</Function> does not change the value unless the
<Emphasis>override</Emphasis> argument is set to True.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>Upon successful completion, the
<Function>DtDtsSetDataType</Function> function returns a pointer to a data type string, or
<SystemItem Class="Constant">NULL</SystemItem> if it was unable to set or retrieve the data type.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>Directories can have data types associated with them,
just as regular files can.
For example, a file manager may choose to
alter the appearance of the directory's icon
based on this data type or a system may
use a directory of files as an means of
supporting a complex form of data, such as
a compund document.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Filename Role="Header">Dt/Dts.h</Filename>, &cdeman.DtDtsLoadDataTypes;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->