summaryrefslogtreecommitdiffstats
path: root/source/text/sbasic/shared/03101000.xhp
blob: 8ec92a79afefaeb6f952ba4ec33059c1a8bfad19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->

<meta>
  <topic id="textsbasicshared03101000xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">CStr Function</title>
    <filename>/text/sbasic/shared/03101000.xhp</filename>
  </topic>
</meta>

<body>


<section id="cstr">
<bookmark xml-lang="en-US" branch="index" id="bm_id3146958">
  <bookmark_value>CStr function</bookmark_value>
</bookmark>


<paragraph id="hd_id3146958" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03101000.xhp" name="CStr Function">CStr Function</link></paragraph>
<paragraph id="par_id3147574" role="paragraph" xml-lang="en-US">Converts any numeric expression to a string expression.</paragraph>
</section>

<paragraph id="hd_id3148473" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3145315" role="bascode" xml-lang="en-US">CStr (Expression)</paragraph>
</bascode>

<paragraph id="hd_id3153062" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US">String</paragraph>

<paragraph id="hd_id3154760" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3149457" role="paragraph" xml-lang="en-US"> <emph>Expression:</emph> Any valid string or numeric expression that you want to convert.</paragraph>

<paragraph id="hd_id3150358" role="heading" level="2" xml-lang="en-US">Expression Types and Conversion Returns</paragraph>

<table id="tbl_id3148797">
  <tablerow>
    <tablecell>
      <paragraph id="par_id3153192" role="paragraph" xml-lang="en-US">Boolean :</paragraph>
    </tablecell>
    <tablecell>
      <paragraph id="par_id3156422" role="paragraph" xml-lang="en-US">String that evaluates to either <emph>True</emph> or <emph>False</emph>.</paragraph>
    </tablecell>
  </tablerow>
  <tablerow>
    <tablecell>
      <paragraph id="par_id3147287" role="paragraph" xml-lang="en-US">Date :</paragraph>
    </tablecell>
    <tablecell>
      <paragraph id="par_id3155411" role="paragraph" xml-lang="en-US">String that contains the date and time.</paragraph>
    </tablecell>
  </tablerow>
  <tablerow>
    <tablecell>
      <paragraph id="par_id3147428" role="paragraph" xml-lang="en-US">Null :</paragraph>
    </tablecell>
    <tablecell>
      <paragraph id="par_id3150486" role="paragraph" xml-lang="en-US">Run-time error.</paragraph>
    </tablecell>
  </tablerow>
  <tablerow>
    <tablecell>
      <paragraph id="par_id3153953" role="paragraph" xml-lang="en-US">Empty :</paragraph>
    </tablecell>
    <tablecell>
      <paragraph id="par_id3155306" role="paragraph" xml-lang="en-US">String without any characters.</paragraph>
    </tablecell>
  </tablerow>
  <tablerow>
    <tablecell>
      <paragraph id="par_id3149260" role="paragraph" xml-lang="en-US">Any :</paragraph>
    </tablecell>
    <tablecell>
      <paragraph id="par_id3152938" role="paragraph" xml-lang="en-US">Corresponding number as string.</paragraph>
    </tablecell>
  </tablerow>
</table>

<paragraph id="par_id3155738" role="paragraph" xml-lang="en-US">Zeros at the end of a floating-point number are not included in the returned string.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>

<paragraph id="hd_id3154729" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1206743296" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCSTR</paragraph>
<paragraph id="par_idm1206742192" role="bascode" localize="false" xml-lang="en-US">Dim sVar As String</paragraph>
<paragraph id="par_idm1206741088" role="bascode" localize="false" xml-lang="en-US">    MsgBox CDbl(1234.5678)</paragraph>
<paragraph id="par_idm1206739936" role="bascode" localize="false" xml-lang="en-US">    MsgBox CInt(1234.5678)</paragraph>
<paragraph id="par_idm1206738784" role="bascode" localize="false" xml-lang="en-US">    MsgBox CLng(1234.5678)</paragraph>
<paragraph id="par_idm1206737632" role="bascode" localize="false" xml-lang="en-US">    MsgBox CSng(1234.5678)</paragraph>
<paragraph id="par_idm1206736480" role="bascode" localize="false" xml-lang="en-US">    sVar = CStr(1234.5678)</paragraph>
<paragraph id="par_idm1206735328" role="bascode" localize="false" xml-lang="en-US">    MsgBox sVar</paragraph>
<paragraph id="par_idm1206734224" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>