1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?>
2*b1cdbd2cSJim Jagielski
3*b1cdbd2cSJim Jagielski
4*b1cdbd2cSJim Jagielski<!--***********************************************************
5*b1cdbd2cSJim Jagielski *
6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
7*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
8*b1cdbd2cSJim Jagielski * distributed with this work for additional information
9*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
12*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
13*b1cdbd2cSJim Jagielski *
14*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
15*b1cdbd2cSJim Jagielski *
16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
21*b1cdbd2cSJim Jagielski * under the License.
22*b1cdbd2cSJim Jagielski *
23*b1cdbd2cSJim Jagielski ***********************************************************-->
24*b1cdbd2cSJim Jagielski
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski<helpdocument version="1.0">
28*b1cdbd2cSJim Jagielski<meta>
29*b1cdbd2cSJim Jagielski<topic id="textsbasicshared03100100xml" indexer="include" status="PUBLISH">
30*b1cdbd2cSJim Jagielski<title id="tit" xml-lang="en-US">CBool Function [Runtime]</title>
31*b1cdbd2cSJim Jagielski<filename>/text/sbasic/shared/03100100.xhp</filename>
32*b1cdbd2cSJim Jagielski</topic>
33*b1cdbd2cSJim Jagielski<history>
34*b1cdbd2cSJim Jagielski<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35*b1cdbd2cSJim Jagielski<lastedited date="2004-08-24T09:51:33">converted from old format - fpe</lastedited>
36*b1cdbd2cSJim Jagielski</history>
37*b1cdbd2cSJim Jagielski</meta>
38*b1cdbd2cSJim Jagielski<body>
39*b1cdbd2cSJim Jagielski<section id="cbool">
40*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3150616"><bookmark_value>CBool function</bookmark_value>
41*b1cdbd2cSJim Jagielski</bookmark>
42*b1cdbd2cSJim Jagielski<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>
43*b1cdbd2cSJim Jagielski<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>
44*b1cdbd2cSJim Jagielski</section>
45*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
46*b1cdbd2cSJim Jagielski<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>
47*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3156152" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
48*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" l10n="U" oldref="6">Bool</paragraph>
49*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3147530" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
50*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U" oldref="8">
51*b1cdbd2cSJim Jagielski<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>
52*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US" l10n="U" oldref="9">
53*b1cdbd2cSJim Jagielski<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>
54*b1cdbd2cSJim Jagielski<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>
55*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
56*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#err5"/>
57*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3156212" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
58*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3147288" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleCBool</paragraph>
59*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153768" xml-lang="en-US" l10n="U" oldref="13">Dim sText As String</paragraph>
60*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3155132" xml-lang="en-US" l10n="U" oldref="14">sText = InputBox("Please enter a short sentence:")</paragraph>
61*b1cdbd2cSJim Jagielski<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>
62*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3146984" xml-lang="en-US" l10n="U" oldref="16">REM Instead of the command line</paragraph>
63*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3148576" xml-lang="en-US" l10n="U" oldref="17">REM If Instr(Input, "and")&lt;&gt;0 Then...</paragraph>
64*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154014" xml-lang="en-US" l10n="U" oldref="18">REM the CBool function is applied as follows:</paragraph>
65*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3155413" xml-lang="en-US" l10n="U" oldref="19">If CBool(Instr(sText, "and")) Then</paragraph>
66*b1cdbd2cSJim Jagielski<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>
67*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U" oldref="21">EndIf</paragraph>
68*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3152886" xml-lang="en-US" l10n="U" oldref="22">End Sub</paragraph>
69*b1cdbd2cSJim Jagielski</body>
70*b1cdbd2cSJim Jagielski</helpdocument>
71