Files
help/helpcontent2/source/text/sbasic/shared/03020405.xhp
2004-08-18 09:59:46 +00:00

111 lines
7.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************************
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc..
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03020405xml" indexer="include" status="PUBLISH">
<title xml-lang="en-US" id="tit">FileAttr-Function [Runtime]</title>
<filename>/text/sbasic/shared/03020405.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2003-10-31T00:00:00">converted from old format - fpe</lastedited>
</history>
</meta>
<body>
<section id="fileattr">
<bookmark xml-lang="en-US" branch="index" id="bm_id3153380"><bookmark_value>FileAttr;function</bookmark_value></bookmark><paragraph id="hd_id3153380" role="heading" level="1" oldref="1" l10n="U" xml-lang="en-US"><link href="text/sbasic/shared/03020405.xhp" name="FileAttr-Function [Runtime]">FileAttr-Function [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3154366" l10n="U" xml-lang="en-US" 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>
</section>
<paragraph role="note" id="par_id3153364" l10n="U" xml-lang="en-US" oldref="3">If you use a 32-Bit operating system, you cannot use the FileAttr-Function to determine the file access number.</paragraph>
<paragraph l10n="U" role="paragraph" id="par_id3163713" xml-lang="en-US" oldref="4">See also: <link href="text/sbasic/shared/03020103.xhp" name="Open">Open</link></paragraph>
<paragraph role="heading" level="2" id="hd_id3151116" l10n="U" xml-lang="en-US" oldref="5">Syntax:</paragraph>
<paragraph role="paragraph" id="par_id3154012" l10n="U" xml-lang="en-US" oldref="6">FileAttr (FileNumber As Integer, Attribute As Integer)</paragraph>
<paragraph role="heading" level="2" id="hd_id3147349" l10n="U" xml-lang="en-US" oldref="7">Return value:</paragraph>
<paragraph role="paragraph" id="par_id3146974" l10n="U" xml-lang="en-US" oldref="8">Integer</paragraph>
<paragraph role="heading" level="2" id="hd_id3153728" l10n="U" xml-lang="en-US" oldref="9">Parameters:</paragraph>
<paragraph l10n="U" role="paragraph" id="par_id3151074" xml-lang="en-US" oldref="10"><emph>FileNumber:</emph> The number of the file that was opened with the Open statement.</paragraph>
<paragraph l10n="U" role="paragraph" id="par_id3144766" xml-lang="en-US" oldref="11"><emph>Attribute:</emph> Integer expression that indicates the type of file information that you to return. The following values are possible:</paragraph>
<paragraph role="paragraph" id="par_id3147396" l10n="U" xml-lang="en-US" oldref="12">1: The FileAttr-Function indicates the access mode of the file.</paragraph>
<paragraph role="paragraph" id="par_id3149959" l10n="U" xml-lang="en-US" oldref="13">2: The FileAttr-Function returns the file access number of the operating system.</paragraph>
<paragraph role="paragraph" id="par_id3154018" l10n="U" xml-lang="en-US" oldref="14">If you specify a parameter attribute with a value of 1, the following return values apply:</paragraph>
<paragraph role="paragraph" id="par_id3149124" l10n="U" xml-lang="en-US" oldref="15">1 - INPUT (file open for input)</paragraph>
<paragraph role="paragraph" id="par_id3156275" l10n="U" xml-lang="en-US" oldref="16">2 - OUTPUT (file open for output)</paragraph>
<paragraph role="paragraph" id="par_id3155066" l10n="U" xml-lang="en-US" oldref="17">4 - RANDOM (file open for random access)</paragraph>
<paragraph role="paragraph" id="par_id3148406" l10n="U" xml-lang="en-US" oldref="18">8 - APPEND (file open for appending)</paragraph>
<paragraph role="paragraph" id="par_id3154757" l10n="U" xml-lang="en-US" oldref="19">32 - BINARY (file open in binary mode).</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err52"/>
<paragraph role="heading" level="2" id="hd_id3147339" l10n="U" xml-lang="en-US" oldref="20">Example:</paragraph>
<paragraph role="paragraph" id="par_id3155959" l10n="U" xml-lang="en-US" oldref="21">Sub ExampleFileAttr</paragraph>
<paragraph role="paragraph" id="par_id3145147" l10n="U" xml-lang="en-US" oldref="22">Dim iNumber As Integer</paragraph>
<paragraph role="paragraph" id="par_id3153966" l10n="U" xml-lang="en-US" oldref="23">Dim sLine As String</paragraph>
<paragraph role="paragraph" id="par_id3155336" l10n="U" xml-lang="en-US" oldref="24">Dim aFile As String</paragraph>
<paragraph role="paragraph" id="par_id3163807" l10n="U" xml-lang="en-US" oldref="25">aFile = "c:\data.txt"</paragraph>
<paragraph role="paragraph" id="par_id3154021" l10n="U" xml-lang="en-US" oldref="27">iNumber = Freefile</paragraph>
<paragraph role="paragraph" id="par_id3153786" l10n="U" xml-lang="en-US" oldref="28">Open aFile For Output As #iNumber</paragraph>
<paragraph role="paragraph" id="par_id3155607" l10n="U" xml-lang="en-US" oldref="29">Print #iNumber, "This is a line of text"</paragraph>
<paragraph role="paragraph" id="par_id3150361" l10n="U" xml-lang="en-US" oldref="30">MsgBox FileAttr(#iNumber, 1 ),0,"Access mode"</paragraph>
<paragraph role="paragraph" id="par_id3149817" l10n="U" xml-lang="en-US" oldref="31">MsgBox FileAttr(#iNumber, 2 ),0,"File attribute"</paragraph>
<paragraph role="paragraph" id="par_id3155115" l10n="U" xml-lang="en-US" oldref="32">Close #iNumber</paragraph>
<paragraph role="paragraph" id="par_id3147130" l10n="U" xml-lang="en-US" oldref="33">End Sub</paragraph>
</body>
</helpdocument>