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="textsbasicshared03120202xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">String Function [Runtime]</title>
28<filename>/text/sbasic/shared/03120202.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="string">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3147291">
34<bookmark_value>String function</bookmark_value>
35</bookmark>
36<paragraph role="heading" id="hd_id3147291" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03120202.xhp" name="String Function [Runtime]">String Function [Runtime]</link></paragraph>
37<paragraph role="paragraph" id="par_id3147242" xml-lang="en-US" l10n="U" oldref="2">Creates a string according to the specified character, or the first character of a string expression that is passed to the function.</paragraph>
38</section>
39<paragraph role="heading" id="hd_id3149516" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
40<paragraph role="paragraph" id="par_id3149233" xml-lang="en-US" l10n="CHG" oldref="4">String (n As Long, {expression As Integer | character As String})</paragraph>
41<paragraph role="heading" id="hd_id3143270" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
42<paragraph role="paragraph" id="par_id3147530" xml-lang="en-US" l10n="U" oldref="6">String</paragraph>
43<paragraph role="heading" id="hd_id3154923" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
44<paragraph role="paragraph" id="par_id3154347" xml-lang="en-US" l10n="CHG" oldref="8">
45<emph>n:</emph> Numeric expression that indicates the number of characters to return in the string. The maximum allowed value of n is 65535.</paragraph>
46<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="9">
47<emph>Expression:</emph> Numeric expression that defines the ASCII code for the character.</paragraph>
48<paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="10">
49<emph>Character:</emph> Any single character used to build the return string, or any string of which only the first character will be used.</paragraph>
50<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
51<embed href="text/sbasic/shared/00000003.xhp#err5"/>
52<paragraph role="heading" id="hd_id3152920" xml-lang="en-US" level="2" l10n="U" oldref="11">Example:</paragraph>
53<paragraph role="paragraph" id="par_id3149203" xml-lang="en-US" l10n="U" oldref="12">Sub ExampleString</paragraph>
54<paragraph role="paragraph" id="par_id3154124" xml-lang="en-US" l10n="U" oldref="13">Dim sText as String</paragraph>
55<paragraph role="paragraph" id="par_id3147230" xml-lang="en-US" l10n="U" oldref="15">sText = String(10,"A")</paragraph>
56<paragraph role="paragraph" id="par_id3153970" xml-lang="en-US" l10n="U" oldref="16">Msgbox sText</paragraph>
57<paragraph role="paragraph" id="par_id3145785" xml-lang="en-US" l10n="U" oldref="18">sText = String(10,65)</paragraph>
58<paragraph role="paragraph" id="par_id3147288" xml-lang="en-US" l10n="U" oldref="19">Msgbox sText</paragraph>
59<paragraph role="paragraph" id="par_id3153138" xml-lang="en-US" l10n="U" oldref="24">End Sub</paragraph>
60</body>
61</helpdocument>
62