xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03100100.xhp (revision 06992ba77bea644ed81ed2764fe6823ca677a016)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3d33d0967SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5d33d0967SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6d33d0967SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7d33d0967SAndrew Rist * distributed with this work for additional information
8d33d0967SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9d33d0967SAndrew Rist * to you under the Apache License, Version 2.0 (the
10d33d0967SAndrew Rist * "License"); you may not use this file except in compliance
11d33d0967SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13d33d0967SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15d33d0967SAndrew Rist * Unless required by applicable law or agreed to in writing,
16d33d0967SAndrew Rist * software distributed under the License is distributed on an
17d33d0967SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18d33d0967SAndrew Rist * KIND, either express or implied.  See the License for the
19d33d0967SAndrew Rist * specific language governing permissions and limitations
20d33d0967SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22d33d0967SAndrew Rist ***********************************************************-->
23d33d0967SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03100100xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">CBool Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03100100.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="cbool">
331832f669Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3150616">
341832f669Smseidel<bookmark_value>CBool function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*06992ba7Smseidel<paragraph role="heading" id="hd_id3150616" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03100100.xhp" name="CBool Function [Runtime]">CBool Function [Runtime]</link></paragraph>
37*06992ba7Smseidel<paragraph role="paragraph" id="par_id3145136" xml-lang="en-US" l10n="U">Converts a string comparison or numeric comparison to a Boolean expression, or converts a single numeric expression to a Boolean expression.</paragraph>
38cdf0e10cSrcweir</section>
39*06992ba7Smseidel<paragraph role="heading" id="hd_id3153345" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*06992ba7Smseidel<paragraph role="paragraph" id="par_id3149514" xml-lang="en-US" l10n="U">CBool (Expression1 {= | &lt;&gt; | &lt; | &gt; | &lt;= | &gt;=} Expression2) or CBool (Number)</paragraph>
41*06992ba7Smseidel<paragraph role="heading" id="hd_id3156152" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*06992ba7Smseidel<paragraph role="paragraph" id="par_id3155419" xml-lang="en-US" l10n="U">Bool</paragraph>
43*06992ba7Smseidel<paragraph role="heading" id="hd_id3147530" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44*06992ba7Smseidel<paragraph role="paragraph" id="par_id3156344" xml-lang="en-US" l10n="U"><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>
45*06992ba7Smseidel<paragraph role="paragraph" id="par_id3149655" xml-lang="en-US" l10n="U"><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>
46*06992ba7Smseidel<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US" l10n="U">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>
47cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
48cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
49*06992ba7Smseidel<paragraph role="heading" id="hd_id3156212" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
50*06992ba7Smseidel<paragraph role="paragraph" id="par_id3147288" xml-lang="en-US" l10n="U">Sub ExampleCBool</paragraph>
51*06992ba7Smseidel<paragraph role="paragraph" id="par_id3153768" xml-lang="en-US" l10n="U">Dim sText As String</paragraph>
52*06992ba7Smseidel<paragraph role="paragraph" id="par_id3155132" xml-lang="en-US" l10n="U">sText = InputBox("Please enter a short sentence:")</paragraph>
53*06992ba7Smseidel<paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U">REM Proof if the word »and« appears in the sentence.</paragraph>
54*06992ba7Smseidel<paragraph role="paragraph" id="par_id3146984" xml-lang="en-US" l10n="U">REM Instead of the command line</paragraph>
55*06992ba7Smseidel<paragraph role="paragraph" id="par_id3148576" xml-lang="en-US" l10n="U">REM If Instr(Input, "and")&lt;&gt;0 Then...</paragraph>
56*06992ba7Smseidel<paragraph role="paragraph" id="par_id3154014" xml-lang="en-US" l10n="U">REM the CBool function is applied as follows:</paragraph>
57*06992ba7Smseidel<paragraph role="paragraph" id="par_id3155413" xml-lang="en-US" l10n="U">If CBool(Instr(sText, "and")) Then</paragraph>
58*06992ba7Smseidel<paragraph role="paragraph" id="par_id3152940" xml-lang="en-US" l10n="U">MsgBox "The word »and« appears in the sentence you entered!"</paragraph>
59*06992ba7Smseidel<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U">EndIf</paragraph>
60*06992ba7Smseidel<paragraph role="paragraph" id="par_id3152886" xml-lang="en-US" l10n="U">End Sub</paragraph>
61cdf0e10cSrcweir</body>
62cdf0e10cSrcweir</helpdocument>
63