summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03102101.xhp
blob: 6d00c0226d4ab09eab76a94e8760405cebeda20b (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
<?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="textsbasicshared03102101xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">ReDim Statement</title>
    <filename>/text/sbasic/shared/03102101.xhp</filename>
  </topic>
</meta>

<body>


<section id="redim">
<bookmark xml-lang="en-US" branch="index" id="bm_id3150398">
  <bookmark_value>ReDim statement</bookmark_value>
</bookmark>


<paragraph id="hd_id3150398" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03102101.xhp" name="ReDim Statement">ReDim Statement</link></paragraph>
<paragraph id="par_id3154685" role="paragraph" xml-lang="en-US">Declares a variable or an array.</paragraph>
</section>

<paragraph id="hd_id3154218" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3156214" role="bascode" xml-lang="en-US">[ReDim]Dim VarName [(start To end)] [As VarType][, VarName2 [(start To end)] [As VarType][,...]]</paragraph>
</bascode>
<paragraph id="par_id711996" role="paragraph" xml-lang="en-US">Optionally, you can add the <emph>Preserve</emph> keyword as a parameter to preserve the contents of the array that is redimensioned.</paragraph>

<paragraph id="hd_id3148451" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3156423" role="paragraph" xml-lang="en-US"> <emph>VarName:</emph> Any variable or array name.</paragraph>
<paragraph id="par_id3149562" role="paragraph" xml-lang="en-US"> <emph>Start, End:</emph> Numerical values or constants that define the number of elements (NumberElements=(end-start)+1) and the index range.</paragraph>
<paragraph id="par_id3155307" role="paragraph" xml-lang="en-US">Start and End can be numeric expressions if ReDim is used at the procedure level.</paragraph>
<paragraph id="par_id3153951" role="paragraph" xml-lang="en-US"> <emph>VarType:</emph> Keyword that declares the data type of a variable.</paragraph>
<paragraph id="par_id3147317" role="paragraph" xml-lang="en-US"> <emph>Keyword:</emph> Variable type</paragraph>
<paragraph id="par_id3153728" role="paragraph" xml-lang="en-US"> <emph>Bool: </emph>Boolean variable (True, False)</paragraph>
<paragraph id="par_id3146121" role="paragraph" xml-lang="en-US"> <emph>Date:</emph> Date variable</paragraph>
<paragraph id="par_id3159156" role="paragraph" xml-lang="en-US"> <emph>Double:</emph> Double floating point variable (1.79769313486232x10E308 - 4.94065645841247x10E-324)</paragraph>
<paragraph id="par_id3148616" role="paragraph" xml-lang="en-US"> <emph>Integer:</emph> Integer variable (-32768 - 32767)</paragraph>
<paragraph id="par_id3147348" role="paragraph" xml-lang="en-US"> <emph>Long:</emph> Long integer variable (-2,147,483,648 - 2,147,483,647)</paragraph>
<paragraph id="par_id3149412" role="paragraph" xml-lang="en-US"> <emph>Object:</emph> Object variable (can only be subsequently defined by Set!)</paragraph>
<paragraph id="par_id3154729" role="paragraph" xml-lang="en-US"> <emph>[Single]:</emph> Single floating-point variable (3.402823x10E38 - 1.401298x10E-45). If no key word is specified, a variable is defined as Single, unless a statement from DefBool to DefVar is used.</paragraph>
<paragraph id="par_id3148458" role="paragraph" xml-lang="en-US"> <emph>String:</emph> String variable containing a maximum of 64,000 ASCII characters.</paragraph>
<paragraph id="par_id3149581" role="paragraph" xml-lang="en-US"> <emph>Variant: </emph>Variant variable type (can contain all types and is set by definition).</paragraph>
<paragraph id="par_id3155601" role="paragraph" xml-lang="en-US">In $[officename] Basic, you do not need to declare variables explicitly. However, you need to declare an array before you can use them. You can declare a variable with the Dim statement, using commas to separate multiple declarations. To declare a variable type, enter a type-declaration character following the name or use a corresponding key word.</paragraph>
<paragraph id="par_id3153415" role="paragraph" xml-lang="en-US">$[officename] Basic supports single or multi-dimensional arrays that are defined by a specified variable type. Arrays are suitable if the program contains lists or tables that you want to edit. The advantage of arrays is that it is possible to address individual elements according to indexes, which can be formulated as numeric expressions or variables.</paragraph>
<paragraph id="par_id3146971" role="paragraph" xml-lang="en-US">There are two ways to set the range of indices for arrays declared with the Dim statement:</paragraph>
<paragraph id="par_id3153950" role="paragraph" xml-lang="en-US">DIM text(20) As String REM 21 elements numbered from 0 to 20</paragraph>
<paragraph id="par_id3146912" role="paragraph" xml-lang="en-US">DIM text(5 to 25) As String REM 21 elements numbered from 5 to 25</paragraph>
<paragraph id="par_id3153709" role="paragraph" xml-lang="en-US">DIM text$(-15 to 5) As String REM 21 elements (0 inclusive),</paragraph>
<paragraph id="par_id3150321" role="paragraph" xml-lang="en-US">rem numbered from -15 to 5</paragraph>
<paragraph id="par_id3149018" role="paragraph" xml-lang="en-US">Variable fields, regardless of type, can be made dynamic if they are dimensioned by ReDim at the procedure level in subroutines or functions. Normally, you can only set the range of an array once and you cannot modify it. Within a procedure, you can declare an array using the ReDim statement with numeric expressions to define the range of the field sizes.</paragraph>

<paragraph id="hd_id3148405" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341054016" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRedim</paragraph>
<paragraph id="par_idm1341052784" role="bascode" localize="false" xml-lang="en-US">Dim iVar() As Integer, iCount As Integer</paragraph>
<paragraph id="par_idm1341051520" role="bascode" localize="false" xml-lang="en-US">ReDim iVar(5) As Integer</paragraph>
<paragraph id="par_idm1341050272" role="bascode" localize="false" xml-lang="en-US">For iCount = 1 To 5</paragraph>
<paragraph id="par_idm1341049040" role="bascode" localize="false" xml-lang="en-US">    iVar(iCount) = iCount</paragraph>
<paragraph id="par_idm1341047792" role="bascode" localize="false" xml-lang="en-US">Next iCount</paragraph>
<paragraph id="par_idm1341046560" role="bascode" localize="false" xml-lang="en-US">ReDim iVar(10) As Integer</paragraph>
<paragraph id="par_idm1341045312" role="bascode" localize="false" xml-lang="en-US">For iCount = 1 To 10</paragraph>
<paragraph id="par_idm1341044080" role="bascode" localize="false" xml-lang="en-US">    iVar(iCount) = iCount</paragraph>
<paragraph id="par_idm1341042832" role="bascode" localize="false" xml-lang="en-US">Next iCount</paragraph>
<paragraph id="par_idm1341041600" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>