1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?> 2*b1cdbd2cSJim Jagielski 3*b1cdbd2cSJim Jagielski 4*b1cdbd2cSJim Jagielski<!--*********************************************************** 5*b1cdbd2cSJim Jagielski * 6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 7*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 8*b1cdbd2cSJim Jagielski * distributed with this work for additional information 9*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 12*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 13*b1cdbd2cSJim Jagielski * 14*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 15*b1cdbd2cSJim Jagielski * 16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 21*b1cdbd2cSJim Jagielski * under the License. 22*b1cdbd2cSJim Jagielski * 23*b1cdbd2cSJim Jagielski ***********************************************************--> 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski<helpdocument version="1.0"> 28*b1cdbd2cSJim Jagielski<meta> 29*b1cdbd2cSJim Jagielski<topic id="textsbasicshared03020404xml" indexer="include" status="PUBLISH"> 30*b1cdbd2cSJim Jagielski<title id="tit" xml-lang="en-US">Dir Function [Runtime]</title> 31*b1cdbd2cSJim Jagielski<filename>/text/sbasic/shared/03020404.xhp</filename> 32*b1cdbd2cSJim Jagielski</topic> 33*b1cdbd2cSJim Jagielski<history> 34*b1cdbd2cSJim Jagielski<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 35*b1cdbd2cSJim Jagielski<lastedited date="2005-09-27T17:09:01">converted from old format - fpe; bug fix: i29276</lastedited> 36*b1cdbd2cSJim Jagielski</history> 37*b1cdbd2cSJim Jagielski</meta> 38*b1cdbd2cSJim Jagielski<body> 39*b1cdbd2cSJim Jagielski<section id="dir"> 40*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3154347"><bookmark_value>Dir function</bookmark_value> 41*b1cdbd2cSJim Jagielski</bookmark> 42*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3154347" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03020404.xhp" name="Dir Function [Runtime]">Dir Function [Runtime]</link></paragraph> 43*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153381" xml-lang="en-US" l10n="U" oldref="2">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> 44*b1cdbd2cSJim Jagielski</section> 45*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3154365" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph> 46*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3156282" xml-lang="en-US" l10n="U" oldref="4">Dir [(Text As String) [, Attrib As Integer]]</paragraph> 47*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3156424" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph> 48*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US" l10n="U" oldref="6">String</paragraph> 49*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3153770" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph> 50*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3161831" xml-lang="en-US" l10n="U" oldref="8"> 51*b1cdbd2cSJim Jagielski<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> 52*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3146974" xml-lang="en-US" l10n="U" oldref="9"> 53*b1cdbd2cSJim Jagielski<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> 54*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3149666" xml-lang="en-US" l10n="U" oldref="11">0 : Normal files.</paragraph> 55*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3147427" xml-lang="en-US" l10n="U" oldref="15">16 : Returns the name of the directory only.</paragraph> 56*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153952" xml-lang="en-US" l10n="U" oldref="16">Use this attribute to check if a file or directory exists, or to determine all files and folders in a specific directory.</paragraph> 57*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3159156" xml-lang="en-US" l10n="U" oldref="17">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> 58*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154012" xml-lang="en-US" l10n="U" oldref="18">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\*.sxw". 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> 59*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3147348" xml-lang="en-US" l10n="U" oldref="19">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> 60*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#errorcode"/> 61*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#err5"/> 62*b1cdbd2cSJim Jagielski<embed href="text/sbasic/shared/00000003.xhp#err53"/> 63*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3154942" xml-lang="en-US" level="2" l10n="U" oldref="20">Example:</paragraph> 64*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3147125" xml-lang="en-US" l10n="U" oldref="21">Sub ExampleDir</paragraph> 65*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3148455" xml-lang="en-US" l10n="U" oldref="22">REM Displays all files and directories</paragraph> 66*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3147396" xml-lang="en-US" l10n="U" oldref="23">Dim sPath As String</paragraph> 67*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3149378" xml-lang="en-US" l10n="U" oldref="24">Dim sDir as String, sValue as String</paragraph> 68*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3153416" xml-lang="en-US" l10n="U" oldref="27">sDir="Directories:"</paragraph> 69*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3153838" xml-lang="en-US" l10n="U" oldref="29">sPath = CurDir</paragraph> 70*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="CHG" oldref="30">sValue = Dir$(sPath + getPathSeparator + "*",16)</paragraph> 71*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3155064" xml-lang="en-US" l10n="U" oldref="31">Do</paragraph> 72*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3153764" xml-lang="en-US" l10n="U" oldref="32">If sValue <> "." and sValue <> ".." Then</paragraph> 73*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3155766" xml-lang="en-US" l10n="U" oldref="33">if (GetAttr( sPath + getPathSeparator + sValue) AND 16) >0 then</paragraph> 74*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3154253" xml-lang="en-US" l10n="U" oldref="34">REM get the directories</paragraph> 75*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3159264" xml-lang="en-US" l10n="U" oldref="35">sDir = sDir & chr(13) & sValue</paragraph> 76*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3145148" xml-lang="en-US" l10n="U" oldref="43">End If</paragraph> 77*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_idN10700" xml-lang="en-US" l10n="NEW">End If</paragraph> 78*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3147324" xml-lang="en-US" l10n="U" oldref="44">sValue = Dir$</paragraph> 79*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3155335" xml-lang="en-US" l10n="U" oldref="45">Loop Until sValue = ""</paragraph> 80*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3147345" xml-lang="en-US" l10n="U" oldref="46">MsgBox sDir,0,sPath</paragraph> 81*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3163808" xml-lang="en-US" l10n="U" oldref="48">End sub</paragraph> 82*b1cdbd2cSJim Jagielski</body> 83*b1cdbd2cSJim Jagielski</helpdocument> 84