1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?> 2cdf0e10cSrcweir 382a1df74SAndrew Rist<!--*********************************************************** 4cdf0e10cSrcweir * 582a1df74SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 682a1df74SAndrew Rist * or more contributor license agreements. See the NOTICE file 782a1df74SAndrew Rist * distributed with this work for additional information 882a1df74SAndrew Rist * regarding copyright ownership. The ASF licenses this file 982a1df74SAndrew Rist * to you under the Apache License, Version 2.0 (the 1082a1df74SAndrew Rist * "License"); you may not use this file except in compliance 1182a1df74SAndrew Rist * with the License. You may obtain a copy of the License at 12cdf0e10cSrcweir * 1382a1df74SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 14cdf0e10cSrcweir * 1582a1df74SAndrew Rist * Unless required by applicable law or agreed to in writing, 1682a1df74SAndrew Rist * software distributed under the License is distributed on an 1782a1df74SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 1882a1df74SAndrew Rist * KIND, either express or implied. See the License for the 1982a1df74SAndrew Rist * specific language governing permissions and limitations 2082a1df74SAndrew Rist * under the License. 21cdf0e10cSrcweir * 2282a1df74SAndrew Rist ***********************************************************--> 2382a1df74SAndrew Rist 24cdf0e10cSrcweir<helpdocument version="1.0"> 25cdf0e10cSrcweir<meta> 26cdf0e10cSrcweir<topic id="textsbasicshared03020405xml" indexer="include" status="PUBLISH"> 27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">FileAttr-Function [Runtime]</title> 28cdf0e10cSrcweir<filename>/text/sbasic/shared/03020405.xhp</filename> 29cdf0e10cSrcweir</topic> 30cdf0e10cSrcweir</meta> 31cdf0e10cSrcweir<body> 32cdf0e10cSrcweir<section id="fileattr"> 33cd3ec106Smseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3153380"> 34cd3ec106Smseidel<bookmark_value>FileAttr function</bookmark_value> 35cdf0e10cSrcweir</bookmark> 36*51a0debcSmseidel<paragraph role="heading" id="hd_id3153380" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03020405.xhp" name="FileAttr-Function [Runtime]">FileAttr Function [Runtime]</link></paragraph> 37*51a0debcSmseidel<paragraph role="paragraph" id="par_id3154366" xml-lang="en-US" l10n="U">Returns the access mode or the file access number of a file that was opened with the Open statement. The file access number is dependent on the operating system (OSH = Operating System Handle).</paragraph> 38cdf0e10cSrcweir</section> 39*51a0debcSmseidel<paragraph role="note" id="par_id3153364" xml-lang="en-US" l10n="U">If you use a 32-Bit operating system, you cannot use the FileAttr-Function to determine the file access number.</paragraph> 40*51a0debcSmseidel<paragraph role="paragraph" id="par_id3163713" xml-lang="en-US" l10n="U">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link></paragraph> 41*51a0debcSmseidel<paragraph role="heading" id="hd_id3151116" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph> 42*51a0debcSmseidel<paragraph role="code" id="par_id3154012" xml-lang="en-US" l10n="U">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph> 43*51a0debcSmseidel<paragraph role="heading" id="hd_id3147349" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph> 44*51a0debcSmseidel<paragraph role="paragraph" id="par_id3146974" xml-lang="en-US" l10n="U">Integer</paragraph> 45*51a0debcSmseidel<paragraph role="heading" id="hd_id3153728" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph> 46*51a0debcSmseidel<paragraph role="paragraph" id="par_id3151074" xml-lang="en-US" l10n="U"><emph>FileNumber:</emph> The number of the file that was opened with the Open statement.</paragraph> 47*51a0debcSmseidel<paragraph role="paragraph" id="par_id3144766" xml-lang="en-US" l10n="U"><emph>Attribute:</emph> Integer expression that indicates the type of file information that you want to return. The following values are possible:</paragraph> 48*51a0debcSmseidel<paragraph role="paragraph" id="par_id3147396" xml-lang="en-US" l10n="U">1: The FileAttr-Function indicates the access mode of the file.</paragraph> 49*51a0debcSmseidel<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U">2: The FileAttr-Function returns the file access number of the operating system.</paragraph> 50*51a0debcSmseidel<paragraph role="paragraph" id="par_id3154018" xml-lang="en-US" l10n="U">If you specify a parameter attribute with a value of 1, the following return values apply:</paragraph> 51*51a0debcSmseidel<paragraph role="paragraph" id="par_id3149124" xml-lang="en-US" l10n="U">1 - INPUT (file open for input)</paragraph> 52*51a0debcSmseidel<paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U">2 - OUTPUT (file open for output)</paragraph> 53*51a0debcSmseidel<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U">4 - RANDOM (file open for random access)</paragraph> 54*51a0debcSmseidel<paragraph role="paragraph" id="par_id3148406" xml-lang="en-US" l10n="U">8 - APPEND (file open for appending)</paragraph> 55*51a0debcSmseidel<paragraph role="paragraph" id="par_id3154757" xml-lang="en-US" l10n="U">32 - BINARY (file open in binary mode).</paragraph> 56cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 57cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/> 58cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err52"/> 59*51a0debcSmseidel<paragraph role="heading" id="hd_id3147339" xml-lang="en-US" level="2" l10n="U">Example:</paragraph> 60*51a0debcSmseidel<paragraph role="code" id="par_id3155959" xml-lang="en-US" l10n="U">Sub ExampleFileAttr</paragraph> 61*51a0debcSmseidel<paragraph role="code" id="par_id3145147" xml-lang="en-US" l10n="U">Dim iNumber As Integer</paragraph> 62*51a0debcSmseidel<paragraph role="code" id="par_id3153966" xml-lang="en-US" l10n="U">Dim sLine As String</paragraph> 63*51a0debcSmseidel<paragraph role="code" id="par_id3155336" xml-lang="en-US" l10n="U">Dim aFile As String</paragraph> 64*51a0debcSmseidel<paragraph role="code" id="par_id3163807" xml-lang="en-US" l10n="U">aFile = "c:\data.txt"</paragraph> 65*51a0debcSmseidel<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U">iNumber = Freefile</paragraph> 66*51a0debcSmseidel<paragraph role="code" id="par_id3153786" xml-lang="en-US" l10n="U">Open aFile For Output As #iNumber</paragraph> 67*51a0debcSmseidel<paragraph role="code" id="par_id3155607" xml-lang="en-US" l10n="U">Print #iNumber, "This is a line of text"</paragraph> 68*51a0debcSmseidel<paragraph role="code" id="par_id3150361" xml-lang="en-US" l10n="U">MsgBox FileAttr(#iNumber, 1 ),0,"Access mode"</paragraph> 69*51a0debcSmseidel<paragraph role="code" id="par_id3149817" xml-lang="en-US" l10n="U">MsgBox FileAttr(#iNumber, 2 ),0,"File attribute"</paragraph> 70*51a0debcSmseidel<paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U">Close #iNumber</paragraph> 71*51a0debcSmseidel<paragraph role="code" id="par_id3147130" xml-lang="en-US" l10n="U">End Sub</paragraph> 72cdf0e10cSrcweir</body> 73cdf0e10cSrcweir</helpdocument> 74