diff options
Diffstat (limited to 'helpcontent2/source/text/sbasic/shared/03020103.xhp')
| -rw-r--r-- | helpcontent2/source/text/sbasic/shared/03020103.xhp | 128 |
1 files changed, 128 insertions, 0 deletions
diff --git a/helpcontent2/source/text/sbasic/shared/03020103.xhp b/helpcontent2/source/text/sbasic/shared/03020103.xhp new file mode 100644 index 000000000..ddf55d217 --- /dev/null +++ b/helpcontent2/source/text/sbasic/shared/03020103.xhp @@ -0,0 +1,128 @@ +<?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="textsbasicshared03020103xml" indexer="include" status="PUBLISH"> + <title id="tit" xml-lang="en-US">Open Statement</title> + <filename>/text/sbasic/shared/03020103.xhp</filename> + </topic> +</meta> + +<body> + + +<section id="open"> +<bookmark xml-lang="en-US" branch="index" id="bm_id3150791"> + <bookmark_value>Open statement</bookmark_value> +</bookmark> + +<h1 id="hd_id3150791"><variable id="Open_h1"><link href="text/sbasic/shared/03020103.xhp" name="Open Statement">Open Statement</link></variable></h1> +<paragraph id="par_id3150769" role="paragraph" xml-lang="en-US">Opens a data channel.</paragraph> +</section> + +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> +<paragraph role="paragraph" id="par_id971587473488701"> + <image src="media/helpimg/sbasic/Open_statement.svg" id="img_id4156296484514"><alt xml-lang="en-US" id="alt_id15152796484514">Open Statement diagram</alt></image> +</paragraph> +<paragraph role="paragraph" id="par_id971587473488702"> + <image src="media/helpimg/sbasic/access_fragment.svg" id="img_id4156296484515"><alt xml-lang="en-US" id="alt_id15152796484515">access fragment diagram</alt></image> +</paragraph> +<paragraph role="paragraph" id="par_id971587473488703"> + <image src="media/helpimg/sbasic/locking_fragment.svg" id="img_id4156296484516"><alt xml-lang="en-US" id="alt_id15152796484516">locking fragment diagram</alt></image> +</paragraph> +<bascode> +<paragraph id="par_id3154124" localize="false" role="bascode">Open pathname For mode [Access io] [locking] As [#]filenum [Len=recLen]</paragraph> +</bascode> + +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3155132" role="paragraph" xml-lang="en-US"> <emph>pathname: </emph>Path and name of the file to open. If you try to read a file that does not exist (Access = Read), an error message appears. If you try to write to a file that does not exist (Access = Write), a new file is created.</paragraph> +<paragraph id="par_id3149262" role="paragraph" xml-lang="en-US"> <emph>mode:</emph> Keyword that specifies the file mode. Valid values: <literal>Append</literal> (append to sequential file), <literal>Binary</literal> (data can be accessed by bytes using Get and Put), <literal>Input</literal> (opens data channel for reading), <literal>Output</literal> (opens data channel for writing), and <literal>Random</literal> (edits relative files).</paragraph> +<paragraph id="par_id3154014" role="paragraph" xml-lang="en-US"> <emph>io:</emph> Keyword that defines the access type. Valid values: <literal>Read</literal> (read-only), <literal>Write</literal> (write-only), <literal>Read Write</literal> (both).</paragraph> +<paragraph id="par_id3150011" role="paragraph" xml-lang="en-US"> <emph>locking:</emph> Keyword that defines the security status of a file after opening. Valid values: <literal>Shared</literal> (file may be opened by other applications), <literal>Lock Read</literal> (file is protected against reading), <literal>Lock Write</literal> (file is protected against writing), <literal>Lock Read Write</literal> (denies file access).</paragraph> +<paragraph id="par_id3153190" role="paragraph" xml-lang="en-US"> <emph>filenum:</emph> Any integer expression from 0 to 511 to indicate the number of a free data channel. You can then pass commands through the data channel to access the file. The file number must be determined by the FreeFile function immediately before the Open statement.</paragraph> + <paragraph id="par_id3151115" role="paragraph" xml-lang="en-US"> <emph>recLen:</emph> For <literal>Random</literal> access files, set the length of the records.<comment>#61736</comment></paragraph> +<note id="par_id3153418">You can only modify the contents of a file that was opened with the Open statement. If you try to open a file that is already open, an error message appears.</note> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> +<section id="FileExample"> +<switch select="sys"> +<case select="WIN"> + <bascode> + <paragraph id="par_idm1341597584" role="bascode" localize="false">Sub ExampleWorkWithAFile</paragraph> + <paragraph id="par_idm1341596336" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_idm1341595104" role="bascode" localize="false"> Dim sLine As String</paragraph> + <paragraph id="par_idm1341593872" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1341592640" role="bascode" localize="false"> Dim sMsg As String</paragraph> + <paragraph id="par_idm1341591408" role="bascode" localize="false"> aFile = "C:\Users\ThisUser\data.txt"</paragraph> + <paragraph id="par_idm1341590160" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341588928" role="bascode" localize="false"> Open aFile For Output As #iNumber</paragraph> + <paragraph id="par_id3154705" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> + <paragraph id="par_id3146916" role="bascode" xml-lang="en-US"> Print #iNumber, "This is another line of text"</paragraph> + <paragraph id="par_idm1341584144" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341582912" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341581680" role="bascode" localize="false"> Open aFile For Input As iNumber</paragraph> + <paragraph id="par_idm1341580432" role="bascode" localize="false"> While Not eof(iNumber)</paragraph> + <paragraph id="par_idm1341579184" role="bascode" localize="false"> Line Input #iNumber, sLine</paragraph> + <paragraph id="par_idm1341577936" role="bascode" localize="false"> If sLine <>"" Then</paragraph> + <paragraph id="par_idm1341576688" role="bascode" localize="false"> sMsg = sMsg & sLine & chr(13)</paragraph> + <paragraph id="par_idm1341575424" role="bascode" localize="false"> End If</paragraph> + <paragraph id="par_idm1341574192" role="bascode" localize="false"> Wend</paragraph> + <paragraph id="par_idm1341572960" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341571728" role="bascode" localize="false"> MsgBox sMsg</paragraph> + <paragraph id="par_idm1341570496" role="bascode" localize="false">End Sub</paragraph> +</bascode> +</case> +<default> + <bascode> + <paragraph id="par_idm1341597147" role="bascode" localize="false">Sub ExampleWorkWithAFile</paragraph> + <paragraph id="par_idm1341596754" role="bascode" localize="false"> Dim iNumber As Integer</paragraph> + <paragraph id="par_idm1341542504" role="bascode" localize="false"> Dim sLine As String</paragraph> + <paragraph id="par_idm1341593122" role="bascode" localize="false"> Dim aFile As String</paragraph> + <paragraph id="par_idm1340442640" role="bascode" localize="false"> Dim sMsg As String</paragraph> + <paragraph id="par_idm1341591014" role="bascode" localize="false"> aFile = "~/data.txt"</paragraph> + <paragraph id="par_idm1341255160" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341581338" role="bascode" localize="false"> Open aFile For Output As #iNumber</paragraph> + <paragraph id="par_id3154705125" role="bascode" xml-lang="en-US"> Print #iNumber, "This is a line of text"</paragraph> + <paragraph id="par_id3146916877" role="bascode" xml-lang="en-US"> Print #iNumber, "This is another line of text"</paragraph> + <paragraph id="par_idm1341584244" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341583242" role="bascode" localize="false"> iNumber = Freefile</paragraph> + <paragraph id="par_idm1341587410" role="bascode" localize="false"> Open aFile For Input As iNumber</paragraph> + <paragraph id="par_idm1341598532" role="bascode" localize="false"> While Not eof(iNumber)</paragraph> + <paragraph id="par_idm1341572054" role="bascode" localize="false"> Line Input #iNumber, sLine</paragraph> + <paragraph id="par_idm1341906936" role="bascode" localize="false"> If sLine <>"" Then</paragraph> + <paragraph id="par_idm1341514488" role="bascode" localize="false"> sMsg = sMsg & sLine & chr(13)</paragraph> + <paragraph id="par_idm1341233424" role="bascode" localize="false"> End If</paragraph> + <paragraph id="par_idm1341575882" role="bascode" localize="false"> Wend</paragraph> + <paragraph id="par_idm1341906960" role="bascode" localize="false"> Close #iNumber</paragraph> + <paragraph id="par_idm1341576638" role="bascode" localize="false"> MsgBox sMsg</paragraph> + <paragraph id="par_idm1341514496" role="bascode" localize="false">End Sub</paragraph> + </bascode> +</default> +</switch> +</section> +<note id="par_id211617107328022">If the <literal>Open</literal> statement tries to open a file to which the current user does not have read/write permissions, an I/O error will be raised.</note> +<section id="relatedtopics" > + <embed href="text/sbasic/shared/03020101.xhp#Close_h1"/> + <embed href="text/sbasic/shared/03020102.xhp#FreeFile_h1"/> + <embed href="text/sbasic/shared/03020202.xhp#Input_h1"/> + <embed href="text/sbasic/shared/03010103.xhp#Print_h1"/> +</section> +</body> +</helpdocument>
\ No newline at end of file |