summaryrefslogtreecommitdiffstats
path: root/source/text/sbasic/shared/03020204.xhp
blob: 79a276ecdec0d646524bd1b12a1afdeb69dbbe5a (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
<?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="textsbasicshared03020204xml" indexer="include" status="PUBLISH">
    <title id="tit" xml-lang="en-US">Put Statement</title>
    <filename>/text/sbasic/shared/03020204.xhp</filename>
  </topic>
</meta>

<body>


<section id="put">
<bookmark xml-lang="en-US" branch="index" id="bm_id3150360">
  <bookmark_value>Put statement</bookmark_value>
</bookmark>


<paragraph id="hd_id3150360" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020204.xhp" name="Put Statement">Put Statement</link></paragraph>
<paragraph id="par_id3154909" role="paragraph" xml-lang="en-US">Writes a record to a relative file or a sequence of bytes to a binary file.</paragraph>
</section>
<paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">See also: <link href="text/sbasic/shared/03020201.xhp" name="Get"><item type="literal">Get</item></link> statement</paragraph>

<paragraph id="hd_id3125863" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
<bascode>
<paragraph id="par_id3155132" role="bascode" xml-lang="en-US">Put [#] FileNumber As Integer, [position], Variable</paragraph>
</bascode>

<paragraph id="hd_id3153190" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph>
<paragraph id="par_id3146120" role="paragraph" xml-lang="en-US"> <emph>FileNumber:</emph> Any integer expression that defines the file that you want to write to.</paragraph>
<paragraph id="par_id3155411" role="paragraph" xml-lang="en-US"> <emph>Position: </emph>For relative files (random access files), the number of the record that you want to write.</paragraph>
<paragraph id="par_id3148576" role="paragraph" xml-lang="en-US">For binary files (binary access), the position of the byte in the file where you want to start writing.</paragraph>
<paragraph id="par_id3153729" role="paragraph" xml-lang="en-US"> <emph>Variable:</emph> Name of the variable that you want to write to the file.</paragraph>
<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US">Note for relative files: If the contents of this variable does not match the length of the record that is specified in the <emph>Len</emph> clause of the <emph>Open</emph> statement, the space between the end of the newly written record and the next record is padded with existing data from the file that you are writing to.</paragraph>
<paragraph id="par_id3155855" role="paragraph" xml-lang="en-US">Note for binary files: The contents of the variables are written to the specified position, and the file pointer is inserted directly after the last byte. No space is left between the records.</paragraph>

<paragraph id="hd_id3154491" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
<bascode>
<paragraph id="par_idm1341567184" role="bascode" localize="false" xml-lang="en-US">Sub ExampleRandomAccess</paragraph>
<paragraph id="par_idm1341565952" role="bascode" localize="false" xml-lang="en-US">Dim iNumber As Integer</paragraph>
<paragraph id="par_id3154729" role="bascode" xml-lang="en-US">Dim sText As Variant ' Must be a variant type</paragraph>
<paragraph id="par_idm1341562976" role="bascode" localize="false" xml-lang="en-US">Dim aFile As String</paragraph>
<paragraph id="par_idm1341561744" role="bascode" localize="false" xml-lang="en-US">    aFile = "c:\data.txt"</paragraph>
<paragraph id="par_idm1341560496" role="bascode" localize="false" xml-lang="en-US">    iNumber = Freefile</paragraph>
<paragraph id="par_idm1341559264" role="bascode" localize="false" xml-lang="en-US">    Open aFile For Random As #iNumber Len=32</paragraph>
<paragraph id="par_id3156278" role="bascode" xml-lang="en-US">    Seek #iNumber,1 ' Position To start writing</paragraph>
<paragraph id="par_id3153711" role="bascode" xml-lang="en-US">    Put #iNumber,, "This is the first line of text" ' Fill line with text</paragraph>
<paragraph id="par_id3155446" role="bascode" xml-lang="en-US">    Put #iNumber,, "This is the second line of text"</paragraph>
<paragraph id="par_id3154255" role="bascode" xml-lang="en-US">    Put #iNumber,, "This is the third line of text"</paragraph>
<paragraph id="par_idm1341550944" role="bascode" localize="false" xml-lang="en-US">    Seek #iNumber,2</paragraph>
<paragraph id="par_idm1341549712" role="bascode" localize="false" xml-lang="en-US">    Get #iNumber,,sText</paragraph>
<paragraph id="par_idm1341548480" role="bascode" localize="false" xml-lang="en-US">    Print sText</paragraph>
<paragraph id="par_idm1341547248" role="bascode" localize="false" xml-lang="en-US">    Close #iNumber</paragraph>
<paragraph id="par_idm1341546016" role="bascode" localize="false" xml-lang="en-US">    iNumber = Freefile</paragraph>
<paragraph id="par_idm1341544784" role="bascode" localize="false" xml-lang="en-US">    Open aFile For Random As #iNumber Len=32</paragraph>
<paragraph id="par_idm1341543520" role="bascode" localize="false" xml-lang="en-US">    Get #iNumber,2,sText</paragraph>
<paragraph id="par_id3150940" role="bascode" xml-lang="en-US">    Put #iNumber,,"This is new text"</paragraph>
<paragraph id="par_idm1341540544" role="bascode" localize="false" xml-lang="en-US">    Get #iNumber,1,sText</paragraph>
<paragraph id="par_idm1341539296" role="bascode" localize="false" xml-lang="en-US">    Get #iNumber,2,sText</paragraph>
<paragraph id="par_id3159102" role="bascode" xml-lang="en-US">    Put #iNumber,20,"This is the text in record 20"</paragraph>
<paragraph id="par_idm1341536304" role="bascode" localize="false" xml-lang="en-US">    Print Lof(#iNumber)</paragraph>
<paragraph id="par_idm1341535072" role="bascode" localize="false" xml-lang="en-US">    Close #iNumber</paragraph>
<paragraph id="par_idm1341533840" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
</body>

</helpdocument>