summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03020404.xhp
diff options
context:
space:
mode:
authorAlain Romedenne <LibreOfficiant@sfr.fr>2020-11-19 10:35:14 +0100
committerOlivier Hallot <olivier.hallot@libreoffice.org>2020-11-25 16:08:32 +0100
commit51923f0e54c44e9fa8a3d35092938f5a228256fd (patch)
tree30c1c29a34123d9896736cc085c15ef87cba9252 /source/text/sbasic/shared/03020404.xhp
parentf1630841a1ccff7db1cef14577590517ee21aecf (diff)
Deprecated tags for ChDir, ChDrive, CurDir
« 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>
Diffstat (limited to 'source/text/sbasic/shared/03020404.xhp')
-rw-r--r--source/text/sbasic/shared/03020404.xhp48
1 files changed, 24 insertions, 24 deletions
diff --git a/source/text/sbasic/shared/03020404.xhp b/source/text/sbasic/shared/03020404.xhp
index 7a763a9f27..5416578ca5 100644
--- a/source/text/sbasic/shared/03020404.xhp
+++ b/source/text/sbasic/shared/03020404.xhp
@@ -27,26 +27,24 @@
<body>
-
<section id="dir">
<bookmark xml-lang="en-US" branch="index" id="bm_id3154347">
<bookmark_value>Dir function</bookmark_value>
</bookmark>
-
-<paragraph id="hd_id3154347" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020404.xhp" name="Dir Function">Dir Function</link></paragraph>
+<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>
-<paragraph id="hd_id3154365" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
-<paragraph id="par_id3156282" role="bascode" xml-lang="en-US">Dir [(Text As String) [, Attrib As Integer]]</paragraph>
+<paragraph id="par_id3156282" role="bascode" localize="false">Dir [(Text As String [, Attrib As Integer])]</paragraph>
</bascode>
-<paragraph id="hd_id3156424" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
+<h2 id="hd_id3156424" xml-lang="en-US">Return value:</h2>
<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US">String</paragraph>
-<paragraph id="hd_id3153770" role="heading" level="2" xml-lang="en-US">Parameters:</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>
@@ -59,27 +57,29 @@
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<embed href="text/sbasic/shared/00000003.xhp#err53"/>
-<paragraph id="hd_id3154942" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
-<paragraph id="par_idm1341562192" role="bascode" localize="false" xml-lang="en-US">Sub ExampleDir</paragraph>
+<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" xml-lang="en-US">Dim sPath As String</paragraph>
-<paragraph id="par_idm1341558000" role="bascode" localize="false" xml-lang="en-US">Dim sDir As String, sValue As String</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" xml-lang="en-US"> sPath = CurDir</paragraph>
-<paragraph id="par_idm1341553808" role="bascode" localize="false" xml-lang="en-US"> sValue = Dir$(sPath + getPathSeparator + "*",16)</paragraph>
-<paragraph id="par_idm1341552544" role="bascode" localize="false" xml-lang="en-US"> Do</paragraph>
-<paragraph id="par_idm1341551312" role="bascode" localize="false" xml-lang="en-US"> If sValue &lt;&gt; "." And sValue &lt;&gt; ".." Then</paragraph>
-<paragraph id="par_idm1341550000" role="bascode" localize="false" xml-lang="en-US"> If (GetAttr( sPath + getPathSeparator + sValue) And 16) &gt;0 Then</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 &lt;&gt; "." And sValue &lt;&gt; ".." Then</paragraph>
+<paragraph id="par_idm1341550000" role="bascode" localize="false"> If (GetAttr( sPath + getPathSeparator + sValue) And 16) &gt;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" xml-lang="en-US"> sDir = sDir &amp; chr(13) &amp; sValue</paragraph>
-<paragraph id="par_idm1341545632" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph>
-<paragraph id="par_idm1341544400" role="bascode" localize="false" xml-lang="en-US"> End If</paragraph>
-<paragraph id="par_idm1341543168" role="bascode" localize="false" xml-lang="en-US"> sValue = Dir$</paragraph>
-<paragraph id="par_idm1341541936" role="bascode" localize="false" xml-lang="en-US"> Loop Until sValue = ""</paragraph>
-<paragraph id="par_idm1341540688" role="bascode" localize="false" xml-lang="en-US"> MsgBox sDir,0,sPath</paragraph>
-<paragraph id="par_idm1341539456" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
+<paragraph id="par_idm1341546912" role="bascode" localize="false"> sDir = sDir &amp; chr(13) &amp; 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>