helpcontent2/source/text/sbasic/shared/03020204.xhp

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3
   4 <!--***********************************************************************
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * Copyright 2008 by Sun Microsystems, Inc.
   9  *
  10  * OpenOffice.org - a multi-platform office productivity suite
  11  *
  12  * $RCSfile: 03020204.xhp,v $
  13  * $Revision: 1.5 $
  14  *
  15  * This file is part of OpenOffice.org.
  16  *
  17  * OpenOffice.org is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU Lesser General Public License version 3
  19  * only, as published by the Free Software Foundation.
  20  *
  21  * OpenOffice.org is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU Lesser General Public License version 3 for more details
  25  * (a copy is included in the LICENSE file that accompanied this code).
  26  *
  27  * You should have received a copy of the GNU Lesser General Public License
  28  * version 3 along with OpenOffice.org.  If not, see
  29  * <http://www.openoffice.org/license.html>
  30  * for a copy of the LGPLv3 License.
  31  *
  32  ************************************************************************-->
  33
  34 <helpdocument version="1.0">
  35 <meta>
  36 <topic id="textsbasicshared03020204xml" indexer="include" status="PUBLISH">
  37 <title id="tit" xml-lang="en-US">Put Statement [Runtime]</title>
  38 <filename>/text/sbasic/shared/03020204.xhp</filename>
  39 </topic>
  40 <history>
  41 <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  42 <lastedited date="2004-09-01T15:23:39">converted from old format - fpe</lastedited>
  43 </history>
  44 </meta>
  45 <body>
  46 <section id="put">
  47 <bookmark xml-lang="en-US" branch="index" id="bm_id3150360"><bookmark_value>Put statement</bookmark_value>
  48 </bookmark>
  49 <paragraph role="heading" id="hd_id3150360" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03020204.xhp" name="Put Statement [Runtime]">Put Statement [Runtime]</link></paragraph>
  50 <paragraph role="paragraph" id="par_id3154909" xml-lang="en-US" l10n="U" oldref="2">Writes a record to a relative file or a sequence of bytes to a binary file.</paragraph>
  51 </section>
  52 <paragraph role="paragraph" id="par_id3156281" xml-lang="en-US" l10n="U" oldref="3">See also: <link href="text/sbasic/shared/03020201.xhp" name="Get"><item type="literal">Get</item></link> statement</paragraph>
  53 <paragraph role="heading" id="hd_id3125863" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
  54 <paragraph role="code" id="par_id3155132" xml-lang="en-US" l10n="U" oldref="5">Put [#] FileNumber As Integer, [position], Variable</paragraph>
  55 <paragraph role="heading" id="hd_id3153190" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameters:</paragraph>
  56 <paragraph role="paragraph" id="par_id3146120" xml-lang="en-US" l10n="U" oldref="7">
  57 <emph>FileNumber:</emph> Any integer expression that defines the file that you want to write to.</paragraph>
  58 <paragraph role="paragraph" id="par_id3155411" xml-lang="en-US" l10n="U" oldref="8">
  59 <emph>Position: </emph>For relative files (random access files), the number of the record that you want to write.</paragraph>
  60 <paragraph role="paragraph" id="par_id3148576" xml-lang="en-US" l10n="U" oldref="9">For binary files (binary access), the position of the byte in the file where you want to start writing.</paragraph>
  61 <paragraph role="paragraph" id="par_id3153729" xml-lang="en-US" l10n="U" oldref="10">
  62 <emph>Variable:</emph> Name of the variable that you want to write to the file.</paragraph>
  63 <paragraph role="paragraph" id="par_id3146974" xml-lang="en-US" l10n="U" oldref="11">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>
  64 <paragraph role="paragraph" id="par_id3155855" xml-lang="en-US" l10n="U" oldref="12">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>
  65 <paragraph role="heading" id="hd_id3154491" xml-lang="en-US" level="2" l10n="U" oldref="13">Example:</paragraph>
  66 <paragraph role="code" id="par_id3149410" xml-lang="en-US" l10n="U" oldref="14">Sub ExampleRandomAccess</paragraph>
  67 <paragraph role="code" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="15">Dim iNumber As Integer</paragraph>
  68 <paragraph role="code" id="par_id3154729" xml-lang="en-US" l10n="U" oldref="16">Dim sText As Variant REM Must be a variant type</paragraph>
  69 <paragraph role="code" id="par_id3156286" xml-lang="en-US" l10n="U" oldref="17">Dim aFile As String</paragraph>
  70 <paragraph role="code" id="par_id3149400" xml-lang="en-US" l10n="U" oldref="18">aFile = "c:\data.txt"</paragraph>
  71 <paragraph role="code" id="par_id3149124" xml-lang="en-US" l10n="U" oldref="20">iNumber = Freefile</paragraph>
  72 <paragraph role="code" id="par_id3150330" xml-lang="en-US" l10n="U" oldref="21">Open aFile For Random As #iNumber Len=32</paragraph>
  73 <paragraph role="code" id="par_id3156278" xml-lang="en-US" l10n="U" oldref="22">Seek #iNumber,1 REM Position to start writing</paragraph>
  74 <paragraph role="code" id="par_id3153711" xml-lang="en-US" l10n="U" oldref="23">Put #iNumber,, "This is the first line of text" REM Fill line with text</paragraph>
  75 <paragraph role="code" id="par_id3155446" xml-lang="en-US" l10n="U" oldref="24">Put #iNumber,, "This is the second line of text"</paragraph>
  76 <paragraph role="code" id="par_id3154255" xml-lang="en-US" l10n="U" oldref="25">Put #iNumber,, "This is the third line of text"</paragraph>
  77 <paragraph role="code" id="par_id3150045" xml-lang="en-US" l10n="U" oldref="26">Seek #iNumber,2</paragraph>
  78 <paragraph role="code" id="par_id3145149" xml-lang="en-US" l10n="U" oldref="27">Get #iNumber,,sText</paragraph>
  79 <paragraph role="code" id="par_id3147363" xml-lang="en-US" l10n="U" oldref="28">Print sText</paragraph>
  80 <paragraph role="code" id="par_id3163806" xml-lang="en-US" l10n="U" oldref="29">Close #iNumber</paragraph>
  81 <paragraph role="code" id="par_id3149568" xml-lang="en-US" l10n="U" oldref="31">iNumber = Freefile</paragraph>
  82 <paragraph role="code" id="par_id3155607" xml-lang="en-US" l10n="U" oldref="32">Open aFile For Random As #iNumber Len=32</paragraph>
  83 <paragraph role="code" id="par_id3154022" xml-lang="en-US" l10n="U" oldref="33">Get #iNumber,2,sText</paragraph>
  84 <paragraph role="code" id="par_id3150940" xml-lang="en-US" l10n="U" oldref="34">Put #iNumber,,"This is new text"</paragraph>
  85 <paragraph role="code" id="par_id3146132" xml-lang="en-US" l10n="U" oldref="35">Get #iNumber,1,sText</paragraph>
  86 <paragraph role="code" id="par_id3154198" xml-lang="en-US" l10n="U" oldref="36">Get #iNumber,2,sText</paragraph>
  87 <paragraph role="code" id="par_id3159102" xml-lang="en-US" l10n="U" oldref="37">Put #iNumber,20,"This is the text in record 20"</paragraph>
  88 <paragraph role="code" id="par_id3153785" xml-lang="en-US" l10n="U" oldref="38">Print Lof(#iNumber)</paragraph>
  89 <paragraph role="code" id="par_id3151277" xml-lang="en-US" l10n="U" oldref="39">Close #iNumber</paragraph>
  90 <paragraph role="code" id="par_id3150786" xml-lang="en-US" l10n="U" oldref="41">end sub</paragraph>
  91 </body>
  92 </helpdocument>