xref: /AOO41X/main/helpcontent2/source/text/sbasic/shared/03020405.xhp (revision 82a1df740f3bb0545214dd777eb727505f94bf38)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3cdf0e10cSrcweir
4*82a1df74SAndrew Rist<!--***********************************************************
5cdf0e10cSrcweir *
6*82a1df74SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
7*82a1df74SAndrew Rist * or more contributor license agreements.  See the NOTICE file
8*82a1df74SAndrew Rist * distributed with this work for additional information
9*82a1df74SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
10*82a1df74SAndrew Rist * to you under the Apache License, Version 2.0 (the
11*82a1df74SAndrew Rist * "License"); you may not use this file except in compliance
12*82a1df74SAndrew Rist * with the License.  You may obtain a copy of the License at
13cdf0e10cSrcweir *
14*82a1df74SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
15cdf0e10cSrcweir *
16*82a1df74SAndrew Rist * Unless required by applicable law or agreed to in writing,
17*82a1df74SAndrew Rist * software distributed under the License is distributed on an
18*82a1df74SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19*82a1df74SAndrew Rist * KIND, either express or implied.  See the License for the
20*82a1df74SAndrew Rist * specific language governing permissions and limitations
21*82a1df74SAndrew Rist * under the License.
22cdf0e10cSrcweir *
23*82a1df74SAndrew Rist ***********************************************************-->
24*82a1df74SAndrew Rist
25*82a1df74SAndrew Rist
26cdf0e10cSrcweir
27cdf0e10cSrcweir<helpdocument version="1.0">
28cdf0e10cSrcweir<meta>
29cdf0e10cSrcweir<topic id="textsbasicshared03020405xml" indexer="include" status="PUBLISH">
30cdf0e10cSrcweir<title id="tit" xml-lang="en-US">FileAttr-Function [Runtime]</title>
31cdf0e10cSrcweir<filename>/text/sbasic/shared/03020405.xhp</filename>
32cdf0e10cSrcweir</topic>
33cdf0e10cSrcweir<history>
34cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35cdf0e10cSrcweir<lastedited date="2004-09-01T15:27:50">converted from old format - fpe</lastedited>
36cdf0e10cSrcweir</history>
37cdf0e10cSrcweir</meta>
38cdf0e10cSrcweir<body>
39cdf0e10cSrcweir<section id="fileattr">
40cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3153380"><bookmark_value>FileAttr function</bookmark_value>
41cdf0e10cSrcweir</bookmark>
42cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153380" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03020405.xhp" name="FileAttr-Function [Runtime]">FileAttr Function [Runtime]</link></paragraph>
43cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154366" xml-lang="en-US" l10n="U" oldref="2">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>
44cdf0e10cSrcweir</section>
45cdf0e10cSrcweir<paragraph role="note" id="par_id3153364" xml-lang="en-US" l10n="U" oldref="3">If you use a 32-Bit operating system, you cannot use the FileAttr-Function to determine the file access number.</paragraph>
46cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3163713" xml-lang="en-US" l10n="U" oldref="4">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link></paragraph>
47cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151116" xml-lang="en-US" level="2" l10n="U" oldref="5">Syntax:</paragraph>
48cdf0e10cSrcweir<paragraph role="code" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="6">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph>
49cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147349" xml-lang="en-US" level="2" l10n="U" oldref="7">Return value:</paragraph>
50cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146974" xml-lang="en-US" l10n="U" oldref="8">Integer</paragraph>
51cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153728" xml-lang="en-US" level="2" l10n="U" oldref="9">Parameters:</paragraph>
52cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151074" xml-lang="en-US" l10n="U" oldref="10">
53cdf0e10cSrcweir<emph>FileNumber:</emph> The number of the file that was opened with the Open statement.</paragraph>
54cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3144766" xml-lang="en-US" l10n="U" oldref="11">
55cdf0e10cSrcweir<emph>Attribute:</emph> Integer expression that indicates the type of file information that you want to return. The following values are possible:</paragraph>
56cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3147396" xml-lang="en-US" l10n="U" oldref="12">1: The FileAttr-Function indicates the access mode of the file.</paragraph>
57cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="13">2: The FileAttr-Function returns the file access number of the operating system.</paragraph>
58cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154018" xml-lang="en-US" l10n="U" oldref="14">If you specify a parameter attribute with a value of 1, the following return values apply:</paragraph>
59cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149124" xml-lang="en-US" l10n="U" oldref="15">1 - INPUT (file open for input)</paragraph>
60cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U" oldref="16">2 - OUTPUT (file open for output)</paragraph>
61cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U" oldref="17">4 - RANDOM (file open for random access)</paragraph>
62cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148406" xml-lang="en-US" l10n="U" oldref="18">8 - APPEND (file open for appending)</paragraph>
63cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154757" xml-lang="en-US" l10n="U" oldref="19">32 - BINARY (file open in binary mode).</paragraph>
64cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
65cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
66cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err52"/>
67cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147339" xml-lang="en-US" level="2" l10n="U" oldref="20">Example:</paragraph>
68cdf0e10cSrcweir<paragraph role="code" id="par_id3155959" xml-lang="en-US" l10n="U" oldref="21">Sub ExampleFileAttr</paragraph>
69cdf0e10cSrcweir<paragraph role="code" id="par_id3145147" xml-lang="en-US" l10n="U" oldref="22">Dim iNumber As Integer</paragraph>
70cdf0e10cSrcweir<paragraph role="code" id="par_id3153966" xml-lang="en-US" l10n="U" oldref="23">Dim sLine As String</paragraph>
71cdf0e10cSrcweir<paragraph role="code" id="par_id3155336" xml-lang="en-US" l10n="U" oldref="24">Dim aFile As String</paragraph>
72cdf0e10cSrcweir<paragraph role="code" id="par_id3163807" xml-lang="en-US" l10n="U" oldref="25">aFile = "c:\data.txt"</paragraph>
73cdf0e10cSrcweir<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U" oldref="27">iNumber = Freefile</paragraph>
74cdf0e10cSrcweir<paragraph role="code" id="par_id3153786" xml-lang="en-US" l10n="U" oldref="28">Open aFile For Output As #iNumber</paragraph>
75cdf0e10cSrcweir<paragraph role="code" id="par_id3155607" xml-lang="en-US" l10n="U" oldref="29">Print #iNumber, "This is a line of text"</paragraph>
76cdf0e10cSrcweir<paragraph role="code" id="par_id3150361" xml-lang="en-US" l10n="U" oldref="30">MsgBox FileAttr(#iNumber, 1 ),0,"Access mode"</paragraph>
77cdf0e10cSrcweir<paragraph role="code" id="par_id3149817" xml-lang="en-US" l10n="U" oldref="31">MsgBox FileAttr(#iNumber, 2 ),0,"File attribute"</paragraph>
78cdf0e10cSrcweir<paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U" oldref="32">Close #iNumber</paragraph>
79cdf0e10cSrcweir<paragraph role="code" id="par_id3147130" xml-lang="en-US" l10n="U" oldref="33">End Sub</paragraph>
80cdf0e10cSrcweir</body>
81cdf0e10cSrcweir</helpdocument>
82