summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/sbasic/shared/03020201.xhp
blob: 300451363d2bdfb29afe98a4a7ff8616b9962198 (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
116
117
118
119
120
121
122
123
124
125
<?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="textsbasicshared03020201xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">Get Statement</title>
    <filename>/text/sbasic/shared/03020201.xhp</filename>
  </topic>
</meta>

<body>

<section id="get">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154927">
  <bookmark_value>Get statement</bookmark_value>
</bookmark>

<h1 id="hd_id3154927"><variable id="Get_h1"><link href="text/sbasic/shared/03020201.xhp">Get Statement</link></variable></h1>
<paragraph id="par_id3145069" role="paragraph" xml-lang="en-US">Reads a record from a relative file, or a sequence of bytes from a binary file, into a variable.</paragraph>
</section>
<paragraph id="par_id3154346" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020204.xhp" name="PUT"><item type="literal">PUT</item></link> Statement</paragraph>

<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<paragraph role="paragraph" id="par_id971587473488701">
  <image src="media/helpimg/sbasic/Get_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Get Statement diagram</alt></image>
</paragraph>
<bascode>
<paragraph id="par_id3150792" role="bascode" xml-lang="en-US">Get [#]fileNum, [recordNum|filePos], variable</paragraph>
</bascode>

<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
<paragraph id="par_id3150448" role="paragraph" xml-lang="en-US"> <emph>fileNum:</emph> Any integer expression that determines the file number.</paragraph>
<paragraph id="par_id3154684" role="paragraph" xml-lang="en-US"> <emph>recordNum:</emph> For files opened in Random mode, <emph>recordNum</emph> is the number of the record that you want to read.</paragraph>
<paragraph id="par_id3153768" role="paragraph" xml-lang="en-US">For files opened in Binary mode, <emph>filePos</emph> is the byte position in the file where the reading starts.</paragraph>
<paragraph id="par_id3147319" role="paragraph" xml-lang="en-US">If <emph>recordNum</emph> and <emph>filePos</emph> are omitted, the current position or the current data record of the file is used.</paragraph>
<paragraph id="par_id3149484" role="paragraph" xml-lang="en-US"><emph>variable:</emph> Name of the variable to be read. With the exception of object variables, you can use any variable type.</paragraph>

<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<section id="ExampleRandomAccess">
<switch select="sys">
<case select="WIN">
  <bascode>
  <paragraph id="par_idm1340774864" role="bascode" localize="false">Sub ExampleRandomAccess</paragraph>
  <paragraph id="par_idm1340773632" role="bascode" localize="false">    Dim iNumber As Integer</paragraph>
  <paragraph id="par_id3155307" role="bascode" xml-lang="en-US">    Dim sText As Variant ' Must be a variant</paragraph>
  <paragraph id="par_idm1340770608" role="bascode" localize="false">    Dim aFile As String</paragraph>
  <paragraph id="par_idm1340769376" role="bascode" localize="false">    aFile = "C:\Users\ThisUser\data.txt"</paragraph>
  <paragraph id="par_idm1340768128" role="bascode" localize="false">    iNumber = Freefile</paragraph>
  <paragraph id="par_idm1340766896" role="bascode" localize="false">    Open aFile For Random As #iNumber Len=32</paragraph>
  <paragraph id="par_id3149411" role="bascode" xml-lang="en-US">    Seek #iNumber,1 ' Position at beginning</paragraph>
  <paragraph id="par_id3153158" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the first line of text" ' Fill line with text</paragraph>
  <paragraph id="par_id3148457" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the second line of text"</paragraph>
  <paragraph id="par_id3150715" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the third line of text"</paragraph>
  <paragraph id="par_idm1340758576" role="bascode" localize="false">    Seek #iNumber,2</paragraph>
  <paragraph id="par_idm1340757344" role="bascode" localize="false">    Get #iNumber, , sText</paragraph>
  <paragraph id="par_idm1340756112" role="bascode" localize="false">    Print sText</paragraph>
  <paragraph id="par_idm1340754880" role="bascode" localize="false">    Close #iNumber</paragraph>
  <paragraph id="par_idm1340753648" role="bascode" localize="false">    iNumber = Freefile</paragraph>
  <paragraph id="par_idm1340752416" role="bascode" localize="false">    Open aFile For Random As #iNumber Len=32</paragraph>
  <paragraph id="par_idm1340751152" role="bascode" localize="false">    Get #iNumber, 2, sText</paragraph>
  <paragraph id="par_id3155938" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is a new text"</paragraph>
  <paragraph id="par_idm1340748176" role="bascode" localize="false">    Get #iNumber, 1, sText</paragraph>
  <paragraph id="par_idm1340746928" role="bascode" localize="false">    Get #iNumber, 2, sText</paragraph>
  <paragraph id="par_id3146916" role="bascode" xml-lang="en-US">    Put #iNumber, 20, "This is the text in record 20"</paragraph>
  <paragraph id="par_idm1340743936" role="bascode" localize="false">    Print Lof(#iNumber)</paragraph>
  <paragraph id="par_idm1340742704" role="bascode" localize="false">    Close #iNumber</paragraph>
  <paragraph id="par_idm1340741472" role="bascode" localize="false">End Sub</paragraph>
  </bascode>
</case>
<default>
  <bascode>
  <paragraph id="par_idm1340774104" role="bascode" localize="false">Sub ExampleRandomAccess</paragraph>
  <paragraph id="par_idm1340773774" role="bascode" localize="false">    Dim iNumber As Integer</paragraph>
  <paragraph id="par_id31553071450" role="bascode" xml-lang="en-US">    Dim sText As Variant ' Must be a variant</paragraph>
  <paragraph id="par_idm1340770200" role="bascode" localize="false">    Dim aFile As String</paragraph>
  <paragraph id="par_idm1340769147" role="bascode" localize="false">    aFile = "~/data.txt"</paragraph>
  <paragraph id="par_idm1340768732" role="bascode" localize="false">    iNumber = Freefile</paragraph>
  <paragraph id="par_idm1340766055" role="bascode" localize="false">    Open aFile For Random As #iNumber Len=32</paragraph>
  <paragraph id="par_id31494111458" role="bascode" xml-lang="en-US">    Seek #iNumber,1 ' Position at beginning</paragraph>
  <paragraph id="par_id31531583325" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the first line of text" ' Fill line with text</paragraph>
  <paragraph id="par_id31484574785" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the second line of text"</paragraph>
  <paragraph id="par_id31507151145" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is the third line of text"</paragraph>
  <paragraph id="par_idm1340758225" role="bascode" localize="false">    Seek #iNumber,2</paragraph>
  <paragraph id="par_idm1340757001" role="bascode" localize="false">    Get #iNumber, , sText</paragraph>
  <paragraph id="par_idm1340756855" role="bascode" localize="false">    Print sText</paragraph>
  <paragraph id="par_idm1340754987" role="bascode" localize="false">    Close #iNumber</paragraph>
  <paragraph id="par_idm1340753695" role="bascode" localize="false">    iNumber = Freefile</paragraph>
  <paragraph id="par_idm1340752334" role="bascode" localize="false">    Open aFile For Random As #iNumber Len=32</paragraph>
  <paragraph id="par_idm1340751547" role="bascode" localize="false">    Get #iNumber, 2, sText</paragraph>
  <paragraph id="par_id31559382236" role="bascode" xml-lang="en-US">    Put #iNumber, , "This is a new text"</paragraph>
  <paragraph id="par_idm1340748447" role="bascode" localize="false">    Get #iNumber, 1, sText</paragraph>
  <paragraph id="par_idm1340746658" role="bascode" localize="false">    Get #iNumber, 2, sText</paragraph>
  <paragraph id="par_id31469165876" role="bascode" xml-lang="en-US">    Put #iNumber, 20, "This is the text in record 20"</paragraph>
  <paragraph id="par_idm1340743004" role="bascode" localize="false">    Print Lof(#iNumber)</paragraph>
  <paragraph id="par_idm1340742125" role="bascode" localize="false">    Close #iNumber</paragraph>
  <paragraph id="par_idm1340741288" role="bascode" localize="false">End Sub</paragraph>
  </bascode>
</default>
</switch>
</section>

<section id="relatedtopics" >
   <embed href="text/sbasic/shared/03020103.xhp#Open_h1"/>
   <embed href="text/sbasic/shared/03020204.xhp#Put_h1"/>
   <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/>
</section>
</body>
</helpdocument>