xref: /AOO41X/main/helpcontent2/source/text/sbasic/shared/03100100.xhp (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2*cdf0e10cSrcweir
3*cdf0e10cSrcweir
4*cdf0e10cSrcweir<!--***********************************************************************
5*cdf0e10cSrcweir *
6*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7*cdf0e10cSrcweir *
8*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
9*cdf0e10cSrcweir *
10*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
11*cdf0e10cSrcweir *
12*cdf0e10cSrcweir * This file is part of OpenOffice.org.
13*cdf0e10cSrcweir *
14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
16*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
17*cdf0e10cSrcweir *
18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
23*cdf0e10cSrcweir *
24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
25*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
27*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
28*cdf0e10cSrcweir *
29*cdf0e10cSrcweir ************************************************************************-->
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir<helpdocument version="1.0">
32*cdf0e10cSrcweir<meta>
33*cdf0e10cSrcweir<topic id="textsbasicshared03100100xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">CBool Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03100100.xhp</filename>
36*cdf0e10cSrcweir</topic>
37*cdf0e10cSrcweir<history>
38*cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39*cdf0e10cSrcweir<lastedited date="2004-08-24T09:51:33">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="cbool">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"><bookmark_value>CBool function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3150616" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03100100.xhp" name="CBool Function [Runtime]">CBool Function [Runtime]</link></paragraph>
47*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145136" xml-lang="en-US" l10n="U" oldref="2">Converts a string comparison or numeric comparison to a Boolean expression, or converts a single numeric expression to a Boolean expression.</paragraph>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
50*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149514" xml-lang="en-US" l10n="U" oldref="4">CBool (Expression1 {= | &lt;&gt; | &lt; | &gt; | &lt;= | &gt;=} Expression2) or CBool (Number)</paragraph>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3156152" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
52*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" l10n="U" oldref="6">Bool</paragraph>
53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147530" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
54*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U" oldref="8">
55*cdf0e10cSrcweir<emph>Expression1, Expression2:</emph> Any string or numeric expressions that you want to compare. If the expressions match, the <emph>CBool</emph> function returns <emph>True</emph>, otherwise <emph>False</emph> is returned.</paragraph>
56*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US" l10n="U" oldref="9">
57*cdf0e10cSrcweir<emph>Number:</emph> Any numeric expression that you want to convert. If the expression equals 0, <emph>False</emph> is returned, otherwise <emph>True</emph> is returned.</paragraph>
58*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US" l10n="U" oldref="10">The following example uses the <emph>CBool</emph> function to evaluate the value that is returned by the <emph>Instr</emph> function. The function checks if the word "and" is found in the sentence that was entered by the user.</paragraph>
59*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
60*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
61*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3156212" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
62*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147288" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleCBool</paragraph>
63*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153768" xml-lang="en-US" l10n="U" oldref="13">Dim sText As String</paragraph>
64*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155132" xml-lang="en-US" l10n="U" oldref="14">sText = InputBox("Please enter a short sentence:")</paragraph>
65*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U" oldref="15">REM Proof if the word »and« appears in the sentence.</paragraph>
66*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146984" xml-lang="en-US" l10n="U" oldref="16">REM Instead of the command line</paragraph>
67*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148576" xml-lang="en-US" l10n="U" oldref="17">REM If Instr(Input, "and")&lt;&gt;0 Then...</paragraph>
68*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154014" xml-lang="en-US" l10n="U" oldref="18">REM the CBool function is applied as follows:</paragraph>
69*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155413" xml-lang="en-US" l10n="U" oldref="19">If CBool(Instr(sText, "and")) Then</paragraph>
70*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152940" xml-lang="en-US" l10n="U" oldref="20">MsgBox "The word »and« appears in the sentence you entered!"</paragraph>
71*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U" oldref="21">EndIf</paragraph>
72*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3152886" xml-lang="en-US" l10n="U" oldref="22">End Sub</paragraph>
73*cdf0e10cSrcweir</body>
74*cdf0e10cSrcweir</helpdocument>
75