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