blob: e138a5186bff53d0be2faa09fc53ea97b3c3b549 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
***********************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03101000xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">CStr Function [Runtime]</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 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>
<paragraph role="paragraph" id="par_id3147574" xml-lang="en-US" l10n="U">Converts any numeric expression to a string expression.</paragraph>
</section>
<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U">CStr (Expression)</paragraph>
<paragraph role="heading" id="hd_id3153062" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U">String</paragraph>
<paragraph role="heading" id="hd_id3154760" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
<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>
<paragraph role="heading" id="hd_id3150358" xml-lang="en-US" level="2" l10n="U">Expression Types and Conversion Returns</paragraph>
<table id="tbl_id3148797">
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3153192" xml-lang="en-US" l10n="U">Boolean :</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<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>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3147287" xml-lang="en-US" l10n="U">Date :</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3155411" xml-lang="en-US" l10n="U">String that contains the date and time.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3147428" xml-lang="en-US" l10n="U">Null :</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3150486" xml-lang="en-US" l10n="U">Run-time error.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3153953" xml-lang="en-US" l10n="U">Empty :</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U">String without any characters.</paragraph>
</tablecell>
</tablerow>
<tablerow>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3149260" xml-lang="en-US" l10n="U">Any :</paragraph>
</tablecell>
<tablecell colspan="" rowspan="">
<paragraph role="paragraph" id="par_id3152938" xml-lang="en-US" l10n="U">Corresponding number as string.</paragraph>
</tablecell>
</tablerow>
</table>
<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>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph role="heading" id="hd_id3154729" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U">Sub ExampleCSTR</paragraph>
<paragraph role="paragraph" id="par_id3154943" xml-lang="en-US" l10n="U">Dim sVar As String</paragraph>
<paragraph role="paragraph" id="par_id3156283" xml-lang="en-US" l10n="U">Msgbox CDbl(1234.5678)</paragraph>
<paragraph role="paragraph" id="par_id3147396" xml-lang="en-US" l10n="U">Msgbox CInt(1234.5678)</paragraph>
<paragraph role="paragraph" id="par_id3155600" xml-lang="en-US" l10n="U">Msgbox CLng(1234.5678)</paragraph>
<paragraph role="paragraph" id="par_id3153416" xml-lang="en-US" l10n="U">Msgbox CSng(1234.5678)</paragraph>
<paragraph role="paragraph" id="par_id3156559" xml-lang="en-US" l10n="U">sVar = CStr(1234.5678)</paragraph>
<paragraph role="paragraph" id="par_id3153947" xml-lang="en-US" l10n="U">MsgBox sVar</paragraph>
<paragraph role="paragraph" id="par_id3150327" xml-lang="en-US" l10n="U">end sub</paragraph>
</body>
</helpdocument>