xref: /AOO41X/main/helpcontent2/source/text/sbasic/shared/03020405.xhp (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2*cdf0e10cSrcweir
3*cdf0e10cSrcweir
4*cdf0e10cSrcweir<!--***********************************************************************
5*cdf0e10cSrcweir *
6*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7*cdf0e10cSrcweir *
8*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
9*cdf0e10cSrcweir *
10*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
11*cdf0e10cSrcweir *
12*cdf0e10cSrcweir * This file is part of OpenOffice.org.
13*cdf0e10cSrcweir *
14*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
15*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
16*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
17*cdf0e10cSrcweir *
18*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
19*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
20*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
22*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
23*cdf0e10cSrcweir *
24*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
25*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
26*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
27*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
28*cdf0e10cSrcweir *
29*cdf0e10cSrcweir ************************************************************************-->
30*cdf0e10cSrcweir
31*cdf0e10cSrcweir<helpdocument version="1.0">
32*cdf0e10cSrcweir<meta>
33*cdf0e10cSrcweir<topic id="textsbasicshared03020405xml" indexer="include" status="PUBLISH">
34*cdf0e10cSrcweir<title id="tit" xml-lang="en-US">FileAttr-Function [Runtime]</title>
35*cdf0e10cSrcweir<filename>/text/sbasic/shared/03020405.xhp</filename>
36*cdf0e10cSrcweir</topic>
37*cdf0e10cSrcweir<history>
38*cdf0e10cSrcweir<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
39*cdf0e10cSrcweir<lastedited date="2004-09-01T15:27:50">converted from old format - fpe</lastedited>
40*cdf0e10cSrcweir</history>
41*cdf0e10cSrcweir</meta>
42*cdf0e10cSrcweir<body>
43*cdf0e10cSrcweir<section id="fileattr">
44*cdf0e10cSrcweir<bookmark xml-lang="en-US" branch="index" id="bm_id3153380"><bookmark_value>FileAttr function</bookmark_value>
45*cdf0e10cSrcweir</bookmark>
46*cdf0e10cSrcweir<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>
47*cdf0e10cSrcweir<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>
48*cdf0e10cSrcweir</section>
49*cdf0e10cSrcweir<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>
50*cdf0e10cSrcweir<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>
51*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3151116" xml-lang="en-US" level="2" l10n="U" oldref="5">Syntax:</paragraph>
52*cdf0e10cSrcweir<paragraph role="code" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="6">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph>
53*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147349" xml-lang="en-US" level="2" l10n="U" oldref="7">Return value:</paragraph>
54*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3146974" xml-lang="en-US" l10n="U" oldref="8">Integer</paragraph>
55*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3153728" xml-lang="en-US" level="2" l10n="U" oldref="9">Parameters:</paragraph>
56*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3151074" xml-lang="en-US" l10n="U" oldref="10">
57*cdf0e10cSrcweir<emph>FileNumber:</emph> The number of the file that was opened with the Open statement.</paragraph>
58*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3144766" xml-lang="en-US" l10n="U" oldref="11">
59*cdf0e10cSrcweir<emph>Attribute:</emph> Integer expression that indicates the type of file information that you want to return. The following values are possible:</paragraph>
60*cdf0e10cSrcweir<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>
61*cdf0e10cSrcweir<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>
62*cdf0e10cSrcweir<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>
63*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3149124" xml-lang="en-US" l10n="U" oldref="15">1 - INPUT (file open for input)</paragraph>
64*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3156275" xml-lang="en-US" l10n="U" oldref="16">2 - OUTPUT (file open for output)</paragraph>
65*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3155066" xml-lang="en-US" l10n="U" oldref="17">4 - RANDOM (file open for random access)</paragraph>
66*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3148406" xml-lang="en-US" l10n="U" oldref="18">8 - APPEND (file open for appending)</paragraph>
67*cdf0e10cSrcweir<paragraph role="paragraph" id="par_id3154757" xml-lang="en-US" l10n="U" oldref="19">32 - BINARY (file open in binary mode).</paragraph>
68*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
69*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
70*cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err52"/>
71*cdf0e10cSrcweir<paragraph role="heading" id="hd_id3147339" xml-lang="en-US" level="2" l10n="U" oldref="20">Example:</paragraph>
72*cdf0e10cSrcweir<paragraph role="code" id="par_id3155959" xml-lang="en-US" l10n="U" oldref="21">Sub ExampleFileAttr</paragraph>
73*cdf0e10cSrcweir<paragraph role="code" id="par_id3145147" xml-lang="en-US" l10n="U" oldref="22">Dim iNumber As Integer</paragraph>
74*cdf0e10cSrcweir<paragraph role="code" id="par_id3153966" xml-lang="en-US" l10n="U" oldref="23">Dim sLine As String</paragraph>
75*cdf0e10cSrcweir<paragraph role="code" id="par_id3155336" xml-lang="en-US" l10n="U" oldref="24">Dim aFile As String</paragraph>
76*cdf0e10cSrcweir<paragraph role="code" id="par_id3163807" xml-lang="en-US" l10n="U" oldref="25">aFile = "c:\data.txt"</paragraph>
77*cdf0e10cSrcweir<paragraph role="code" id="par_id3154021" xml-lang="en-US" l10n="U" oldref="27">iNumber = Freefile</paragraph>
78*cdf0e10cSrcweir<paragraph role="code" id="par_id3153786" xml-lang="en-US" l10n="U" oldref="28">Open aFile For Output As #iNumber</paragraph>
79*cdf0e10cSrcweir<paragraph role="code" id="par_id3155607" xml-lang="en-US" l10n="U" oldref="29">Print #iNumber, "This is a line of text"</paragraph>
80*cdf0e10cSrcweir<paragraph role="code" id="par_id3150361" xml-lang="en-US" l10n="U" oldref="30">MsgBox FileAttr(#iNumber, 1 ),0,"Access mode"</paragraph>
81*cdf0e10cSrcweir<paragraph role="code" id="par_id3149817" xml-lang="en-US" l10n="U" oldref="31">MsgBox FileAttr(#iNumber, 2 ),0,"File attribute"</paragraph>
82*cdf0e10cSrcweir<paragraph role="code" id="par_id3155115" xml-lang="en-US" l10n="U" oldref="32">Close #iNumber</paragraph>
83*cdf0e10cSrcweir<paragraph role="code" id="par_id3147130" xml-lang="en-US" l10n="U" oldref="33">End Sub</paragraph>
84*cdf0e10cSrcweir</body>
85*cdf0e10cSrcweir</helpdocument>
86