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

<!-- $XConsortium: IsTrue.sgm /main/6 1996/09/08 20:21:54 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.MAN43.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN43.rsml.1">]]>
<RefMeta>
<RefEntryTitle>DtDtsIsTrue</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>DtDtsIsTrue</Function></RefName>
<RefPurpose>return a Boolean value associated with a string
</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>Boolean <Function>DtDtsIsTrue</Function></FuncDef>
<ParamDef>const char *<Parameter>string</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Function>DtDtsIsTrue</Function> function tests a string for a Boolean value.
Any of the following
<Symbol Role="Variable">string</Symbol> values, without regard to case,
causes a return value of True:
</Para>
<InformalExample Remap="indent">
<ProgramListing>true
yes
on
1
</ProgramListing>
</InformalExample>
</RefSect1>
<RefSect1>
<Title>RETURN VALUE</Title>
<Para>The
<Function>DtDtsIsTrue</Function> function returns True if the
<Symbol Role="Variable">string</Symbol> represents a true value;
otherwise, it returns False.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><Filename Role="Header">Dt/Dts.h</Filename>, &cdeman.DtDtsBufferToAttributeList;, &cdeman.DtDtsBufferToAttributeValue;, &cdeman.DtDtsFileToAttributeList;, &cdeman.DtDtsFileToAttributeValue;, &cdeman.DtDtsDataTypeToAttributeList;, &cdeman.DtDtsDataTypeToAttributeValue;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->