forked from amazingfate/help
51923f0e54
« Some DOS-specific file and directory functions are no longer provided in StarOffice 7, or their function is only limited. For example, support for the ChDir, ChDrive and CurDir functions is not provided. Some DOS-specific properties are no longer used in functions that expect file properties as parameters (for example, to differentiate from concealed files and system files). This change became necessary to ensure the greatest possible level of platform independence for StarOffice. » - as of page 54 of "StarOffice 7 Basic Programmer's Guide" cf. http://www.staroffice.com/SO7/so-7-ga-en-BASIC_GUIDE.PDF - 2003 « The functions ChDir and ChDrive, although present in Basic, do nothing and will likely be removed from the language. Their original purpose was to change the current drive and directory, but this was a system wide change, which is dangerous in multitasking environments like we use today. The initial current directory is dependent upon the operating system and how LO was opened. The initial values, therefore, cannot be assumed. » - as of page 172 of Andrew Pitonyak's "OOo Macros Explained v.4" cf. http://www.pitonyak.org/OOME_4_0.odt - 2018 Typo in syntax of Dir Function - add reference to CurDir Change-Id: I3826f953ba24c3bf631cf15357c0717593ead514 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/106009 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
86 lines
6.3 KiB
XML
86 lines
6.3 KiB
XML
<?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="textsbasicshared03020404xml" indexer="include" status="PUBLISH">
|
|
<title id="tit" xml-lang="en-US">Dir Function</title>
|
|
<filename>/text/sbasic/shared/03020404.xhp</filename>
|
|
</topic>
|
|
</meta>
|
|
|
|
<body>
|
|
|
|
<section id="dir">
|
|
<bookmark xml-lang="en-US" branch="index" id="bm_id3154347">
|
|
<bookmark_value>Dir function</bookmark_value>
|
|
</bookmark>
|
|
|
|
<h1 id="hd_id3154347" xml-lang="en-US"><link href="text/sbasic/shared/03020404.xhp" name="Dir Function">Dir Function</link></h1>
|
|
<paragraph id="par_id3153381" role="paragraph" xml-lang="en-US">Returns the name of a file, a directory, or all of the files and the directories on a drive or in a directory that match the specified search path.</paragraph>
|
|
</section>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
|
|
<bascode>
|
|
<paragraph id="par_id3156282" role="bascode" localize="false">Dir [(Text As String [, Attrib As Integer])]</paragraph>
|
|
</bascode>
|
|
|
|
<h2 id="hd_id3156424" xml-lang="en-US">Return value:</h2>
|
|
<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US">String</paragraph>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
|
|
<paragraph id="par_id3161831" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the search path, directory or file. This argument can only be specified the first time that you call the Dir function. If you want, you can enter the path in <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph>
|
|
<paragraph id="par_id3146974" role="paragraph" xml-lang="en-US"> <emph>Attrib: </emph>Any integer expression that specifies bitwise file attributes. The Dir function only returns files or directories that match the specified attributes. You can combine several attributes by adding the attribute values:</paragraph>
|
|
<paragraph id="par_id3149666" role="paragraph" xml-lang="en-US">0 : Normal files.</paragraph>
|
|
<paragraph id="par_id3147427" role="paragraph" xml-lang="en-US">16 : Returns the name of the directory only.</paragraph>
|
|
<paragraph id="par_id3153952" role="paragraph" xml-lang="en-US">Use this attribute to check if a file or directory exists, or to determine all files and folders in a specific directory.</paragraph>
|
|
<paragraph id="par_id3159156" role="paragraph" xml-lang="en-US">To check if a file exists, enter the complete path and name of the file. If the file or directory name does not exist, the Dir function returns a zero-length string ("").</paragraph>
|
|
<paragraph id="par_id3154012" role="paragraph" xml-lang="en-US">To generate a list of all existing files in a specific directory, proceed as follows: The first time you call the Dir function, specify the complete search path for the files, for example, "D:\Files\*.ods". If the path is correct and the search finds at least one file, the Dir function returns the name of the first file that matches the search path. To return additional file names that match the path, call Dir again, but with no arguments.</paragraph>
|
|
<paragraph id="par_id3147348" role="paragraph" xml-lang="en-US">To return directories only, use the attribute parameter. The same applies if you want to determine the name of a volume (for example, a hard drive partition).</paragraph>
|
|
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err53"/>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
|
|
<bascode>
|
|
<paragraph id="par_idm1341562192" role="bascode" localize="false">Sub ExampleDir</paragraph>
|
|
<paragraph id="par_id3148455" role="bascode" xml-lang="en-US">' Displays all files and directories</paragraph>
|
|
<paragraph id="par_idm1341559232" role="bascode" localize="false">Dim sPath As String</paragraph>
|
|
<paragraph id="par_idm1341558000" role="bascode" localize="false">Dim sDir As String, sValue As String</paragraph>
|
|
<paragraph id="par_id3153416" role="bascode" xml-lang="en-US"> sDir="Directories:"</paragraph>
|
|
<paragraph id="par_idm1341555040" role="bascode" localize="false"> sPath = CurDir</paragraph>
|
|
<paragraph id="par_idm1341553808" role="bascode" localize="false"> sValue = Dir$(sPath + getPathSeparator + "*",16)</paragraph>
|
|
<paragraph id="par_idm1341552544" role="bascode" localize="false"> Do</paragraph>
|
|
<paragraph id="par_idm1341551312" role="bascode" localize="false"> If sValue <> "." And sValue <> ".." Then</paragraph>
|
|
<paragraph id="par_idm1341550000" role="bascode" localize="false"> If (GetAttr( sPath + getPathSeparator + sValue) And 16) >0 Then</paragraph>
|
|
<paragraph id="par_id3154253" role="bascode" xml-lang="en-US"> ' Get the directories</paragraph>
|
|
<paragraph id="par_idm1341546912" role="bascode" localize="false"> sDir = sDir & chr(13) & sValue</paragraph>
|
|
<paragraph id="par_idm1341545632" role="bascode" localize="false"> End If</paragraph>
|
|
<paragraph id="par_idm1341544400" role="bascode" localize="false"> End If</paragraph>
|
|
<paragraph id="par_idm1341543168" role="bascode" localize="false"> sValue = Dir$</paragraph>
|
|
<paragraph id="par_idm1341541936" role="bascode" localize="false"> Loop Until sValue = ""</paragraph>
|
|
<paragraph id="par_idm1341540688" role="bascode" localize="false"> MsgBox sDir,0,sPath</paragraph>
|
|
<paragraph id="par_idm1341539456" role="bascode" localize="false">End Sub</paragraph>
|
|
</bascode>
|
|
<section id="relatedtopics">
|
|
<embed href="text/sbasic/shared/03020403.xhp#CurDir_h1"/>
|
|
</section>
|
|
</body>
|
|
</helpdocument>
|