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" oldref="1"><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" oldref="2">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" oldref="3">Syntax:</paragraph>
40<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U" oldref="4">CStr (Expression)</paragraph>
41<paragraph role="heading" id="hd_id3153062" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
42<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="6">String</paragraph>
43<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
44<paragraph role="paragraph" id="par_id3149457" xml-lang="en-US" l10n="U" oldref="8">
45<emph>Expression:</emph> Any valid string or numeric expression that you want to convert.</paragraph>
46<paragraph role="heading" id="hd_id3150358" xml-lang="en-US" level="2" l10n="U" oldref="9">Expression Types and Conversion Returns</paragraph>
47<table id="tbl_id3148797">
48<tablerow>
49<tablecell colspan="" rowspan="">
50<paragraph role="paragraph" id="par_id3153192" xml-lang="en-US" l10n="U" oldref="10">Boolean :</paragraph>
51</tablecell>
52<tablecell colspan="" rowspan="">
53<paragraph role="paragraph" id="par_id3156422" xml-lang="en-US" l10n="U" oldref="11">String that evaluates to either <emph>True</emph> or <emph>False</emph>.</paragraph>
54</tablecell>
55</tablerow>
56<tablerow>
57<tablecell colspan="" rowspan="">
58<paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U" oldref="12">Date :</paragraph>
59</tablecell>
60<tablecell colspan="" rowspan="">
61<paragraph role="paragraph" id="par_id3155411" xml-lang="en-US" l10n="U" oldref="13">String that contains the date and time.</paragraph>
62</tablecell>
63</tablerow>
64<tablerow>
65<tablecell colspan="" rowspan="">
66<paragraph role="paragraph" id="par_id3147428" xml-lang="en-US" l10n="U" oldref="14">Null :</paragraph>
67</tablecell>
68<tablecell colspan="" rowspan="">
69<paragraph role="paragraph" id="par_id3150486" xml-lang="en-US" l10n="U" oldref="15">Run-time error.</paragraph>
70</tablecell>
71</tablerow>
72<tablerow>
73<tablecell colspan="" rowspan="">
74<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U" oldref="16">Empty :</paragraph>
75</tablecell>
76<tablecell colspan="" rowspan="">
77<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="17">String without any characters.</paragraph>
78</tablecell>
79</tablerow>
80<tablerow>
81<tablecell colspan="" rowspan="">
82<paragraph role="paragraph" id="par_id3149260" xml-lang="en-US" l10n="U" oldref="18">Any :</paragraph>
83</tablecell>
84<tablecell colspan="" rowspan="">
85<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U" oldref="19">Corresponding number as string.</paragraph>
86</tablecell>
87</tablerow>
88</table>
89<paragraph role="paragraph" id="par_id3155738" xml-lang="en-US" l10n="U" oldref="20">Zeros at the end of a floating-point number are not included in the returned string.</paragraph>
90<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
91<embed href="text/sbasic/shared/00000003.xhp#err5"/>
92<paragraph role="heading" id="hd_id3154729" xml-lang="en-US" level="2" l10n="U" oldref="21">Example:</paragraph>
93<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U" oldref="22">Sub ExampleCSTR</paragraph>
94<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U" oldref="23">Dim sVar As String</paragraph>
95<paragraph role="paragraph" id="par_id3156283" xml-lang="en-US" l10n="U" oldref="24">Msgbox CDbl(1234.5678)</paragraph>
96<paragraph role="paragraph" id="par_id3147396" xml-lang="en-US" l10n="U" oldref="25">Msgbox CInt(1234.5678)</paragraph>
97<paragraph role="paragraph" id="par_id3155600" xml-lang="en-US" l10n="U" oldref="26">Msgbox CLng(1234.5678)</paragraph>
98<paragraph role="paragraph" id="par_id3153416" xml-lang="en-US" l10n="U" oldref="27">Msgbox CSng(1234.5678)</paragraph>
99<paragraph role="paragraph" id="par_id3156559" xml-lang="en-US" l10n="U" oldref="28">sVar = CStr(1234.5678)</paragraph>
100<paragraph role="paragraph" id="par_id3153947" xml-lang="en-US" l10n="U" oldref="29">MsgBox sVar</paragraph>
101<paragraph role="paragraph" id="par_id3150327" xml-lang="en-US" l10n="U" oldref="30">end sub</paragraph>
102</body>
103</helpdocument>
104