xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03120202.xhp (revision ecb251e43c884fb3852ec3e80b9ad476aa76f688)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3226a8927SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5226a8927SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6226a8927SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7226a8927SAndrew Rist * distributed with this work for additional information
8226a8927SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9226a8927SAndrew Rist * to you under the Apache License, Version 2.0 (the
10226a8927SAndrew Rist * "License"); you may not use this file except in compliance
11226a8927SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13226a8927SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15226a8927SAndrew Rist * Unless required by applicable law or agreed to in writing,
16226a8927SAndrew Rist * software distributed under the License is distributed on an
17226a8927SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18226a8927SAndrew Rist * KIND, either express or implied.  See the License for the
19226a8927SAndrew Rist * specific language governing permissions and limitations
20226a8927SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22226a8927SAndrew Rist ***********************************************************-->
23226a8927SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03120202xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">String Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03120202.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="string">
3336faf8a5Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3147291">
3436faf8a5Smseidel<bookmark_value>String function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*ecb251e4Smseidel<paragraph role="heading" id="hd_id3147291" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03120202.xhp" name="String Function [Runtime]">String Function [Runtime]</link></paragraph>
37*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3147242" xml-lang="en-US" l10n="U">Creates a string according to the specified character, or the first character of a string expression that is passed to the function.</paragraph>
38cdf0e10cSrcweir</section>
39*ecb251e4Smseidel<paragraph role="heading" id="hd_id3149516" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3149233" xml-lang="en-US" l10n="CHG">String (n As Long, {expression As Integer | character As String})</paragraph>
41*ecb251e4Smseidel<paragraph role="heading" id="hd_id3143270" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3147530" xml-lang="en-US" l10n="U">String</paragraph>
43*ecb251e4Smseidel<paragraph role="heading" id="hd_id3154923" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
44*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3154347" xml-lang="en-US" l10n="CHG"><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>
45*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U"><emph>Expression:</emph> Numeric expression that defines the ASCII code for the character.</paragraph>
46*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U"><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>
47cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
48cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
49*ecb251e4Smseidel<paragraph role="heading" id="hd_id3152920" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
50*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3149203" xml-lang="en-US" l10n="U">Sub ExampleString</paragraph>
51*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3154124" xml-lang="en-US" l10n="U">Dim sText as String</paragraph>
52*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3147230" xml-lang="en-US" l10n="U">sText = String(10,"A")</paragraph>
53*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3153970" xml-lang="en-US" l10n="U">Msgbox sText</paragraph>
54*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3145785" xml-lang="en-US" l10n="U">sText = String(10,65)</paragraph>
55*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3147288" xml-lang="en-US" l10n="U">Msgbox sText</paragraph>
56*ecb251e4Smseidel<paragraph role="paragraph" id="par_id3153138" xml-lang="en-US" l10n="U">End Sub</paragraph>
57cdf0e10cSrcweir</body>
58cdf0e10cSrcweir</helpdocument>
59