xref: /trunk/main/helpcontent2/source/text/sbasic/shared/03101000.xhp (revision 31bbceb0f9d64c0c2c3b22a794a1666c1f33396e)
1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03101000xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">CStr Function [Runtime]</title>
28<filename>/text/sbasic/shared/03101000.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="cstr">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3146958">
34<bookmark_value>CStr function</bookmark_value>
35</bookmark>
36<paragraph role="heading" id="hd_id3146958" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03101000.xhp" name="CStr Function [Runtime]">CStr Function [Runtime]</link></paragraph>
37<paragraph role="paragraph" id="par_id3147574" xml-lang="en-US" l10n="U">Converts any numeric expression to a string expression.</paragraph>
38</section>
39<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U">CStr (Expression)</paragraph>
41<paragraph role="heading" id="hd_id3153062" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U">String</paragraph>
43<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44<paragraph role="paragraph" id="par_id3149457" xml-lang="en-US" l10n="U"><emph>Expression:</emph> Any valid string or numeric expression that you want to convert.</paragraph>
45<paragraph role="heading" id="hd_id3150358" xml-lang="en-US" level="2" l10n="U">Expression Types and Conversion Returns</paragraph>
46<table id="tbl_id3148797">
47<tablerow>
48<tablecell colspan="" rowspan="">
49<paragraph role="paragraph" id="par_id3153192" xml-lang="en-US" l10n="U">Boolean :</paragraph>
50</tablecell>
51<tablecell colspan="" rowspan="">
52<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="U">String that evaluates to either <emph>True</emph> or <emph>False</emph>.</paragraph>
53</tablecell>
54</tablerow>
55<tablerow>
56<tablecell colspan="" rowspan="">
57<paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U">Date :</paragraph>
58</tablecell>
59<tablecell colspan="" rowspan="">
60<paragraph role="paragraph" id="par_id3155411" xml-lang="en-US" l10n="U">String that contains the date and time.</paragraph>
61</tablecell>
62</tablerow>
63<tablerow>
64<tablecell colspan="" rowspan="">
65<paragraph role="paragraph" id="par_id3147428" xml-lang="en-US" l10n="U">Null :</paragraph>
66</tablecell>
67<tablecell colspan="" rowspan="">
68<paragraph role="paragraph" id="par_id3150486" xml-lang="en-US" l10n="U">Run-time error.</paragraph>
69</tablecell>
70</tablerow>
71<tablerow>
72<tablecell colspan="" rowspan="">
73<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U">Empty :</paragraph>
74</tablecell>
75<tablecell colspan="" rowspan="">
76<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U">String without any characters.</paragraph>
77</tablecell>
78</tablerow>
79<tablerow>
80<tablecell colspan="" rowspan="">
81<paragraph role="paragraph" id="par_id3149260" xml-lang="en-US" l10n="U">Any :</paragraph>
82</tablecell>
83<tablecell colspan="" rowspan="">
84<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U">Corresponding number as string.</paragraph>
85</tablecell>
86</tablerow>
87</table>
88<paragraph role="paragraph" id="par_id3155738" xml-lang="en-US" l10n="U">Zeros at the end of a floating-point number are not included in the returned string.</paragraph>
89<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
90<embed href="text/sbasic/shared/00000003.xhp#err5"/>
91<paragraph role="heading" id="hd_id3154729" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
92<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U">Sub ExampleCSTR</paragraph>
93<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U">Dim sVar As String</paragraph>
94<paragraph role="paragraph" id="par_id3156283" xml-lang="en-US" l10n="U">Msgbox CDbl(1234.5678)</paragraph>
95<paragraph role="paragraph" id="par_id3147396" xml-lang="en-US" l10n="U">Msgbox CInt(1234.5678)</paragraph>
96<paragraph role="paragraph" id="par_id3155600" xml-lang="en-US" l10n="U">Msgbox CLng(1234.5678)</paragraph>
97<paragraph role="paragraph" id="par_id3153416" xml-lang="en-US" l10n="U">Msgbox CSng(1234.5678)</paragraph>
98<paragraph role="paragraph" id="par_id3156559" xml-lang="en-US" l10n="U">sVar = CStr(1234.5678)</paragraph>
99<paragraph role="paragraph" id="par_id3153947" xml-lang="en-US" l10n="U">MsgBox sVar</paragraph>
100<paragraph role="paragraph" id="par_id3150327" xml-lang="en-US" l10n="U">end sub</paragraph>
101</body>
102</helpdocument>
103