source/text/sbasic/shared/03020401.xhp | 34 +++++++++++------------ source/text/sbasic/shared/03020402.xhp | 12 +++----- source/text/sbasic/shared/03020403.xhp | 41 +++++++++++++--------------- source/text/sbasic/shared/03020404.xhp | 48 ++++++++++++++++----------------- 4 files changed, 65 insertions(+), 70 deletions(-)
New commits: commit 51923f0e54c44e9fa8a3d35092938f5a228256fd Author: Alain Romedenne <[email protected]> AuthorDate: Thu Nov 19 10:35:14 2020 +0100 Commit: Olivier Hallot <[email protected]> CommitDate: Wed Nov 25 16:08:32 2020 +0100 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 <[email protected]> diff --git a/source/text/sbasic/shared/03020401.xhp b/source/text/sbasic/shared/03020401.xhp index eea88c05f..220fb4d8d 100644 --- a/source/text/sbasic/shared/03020401.xhp +++ b/source/text/sbasic/shared/03020401.xhp @@ -27,44 +27,42 @@ <body> - <section id="chdir"> <bookmark xml-lang="en-US" branch="index" id="bm_id3150178"> <bookmark_value>ChDir statement</bookmark_value> </bookmark> - -<paragraph id="hd_id3150178" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020401.xhp" name="ChDir Statement">ChDir Statement</link></paragraph> +<h1 id="hd_id3150178" xml-lang="en-US"><link href="text/sbasic/shared/03020401.xhp" name="ChDir Statement">ChDir Statement</link></h1> <paragraph id="par_id3153126" role="paragraph" xml-lang="en-US">Changes the current directory or drive.</paragraph> </section> -<section id="i30692"> -<paragraph id="par_id9783013" role="warning" xml-lang="en-US">This statement currently does not work as documented. See <link href="https://bz.apache.org/ooo/show_bug.cgi?id=30692";>this issue</link> for more information.</paragraph> +<section id="deprecated_inStarOffice7"> +<warning id="par_id461605879610611" xml-lang="en-US">Some DOS-specific file and directory functions are no longer provided in %PRODUCTNAME, or their function is only limited. For example, support for the <literal>ChDir</literal>, <literal>ChDrive</literal> and <literal>CurDir</literal> 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 ensures the greatest possible level of platform independence for %PRODUCTNAME. Therefore this feature is subject to removal in a future release.</warning> </section> -<paragraph id="hd_id3154347" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <bascode> <paragraph id="par_id3153897" role="bascode" xml-lang="en-US">ChDir Text As String</paragraph> </bascode> -<paragraph id="hd_id3148664" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> <paragraph id="par_id3150543" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies the directory path or drive.</paragraph> <paragraph id="par_id3152598" role="note" xml-lang="en-US">If you only want to change the current drive, enter the drive letter followed by a colon.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> <embed href="text/sbasic/shared/00000003.xhp#err5"/> <embed href="text/sbasic/shared/00000003.xhp#err76"/> - -<paragraph id="hd_id3151116" role="heading" level="2" xml-lang="en-US">Example:</paragraph> + +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> <bascode> -<paragraph id="par_idm1341266032" role="bascode" localize="false" xml-lang="en-US">Sub ExampleChDir</paragraph> -<paragraph id="par_idm1341264800" role="bascode" localize="false" xml-lang="en-US">Dim sDir1 As String , sDir2 As String</paragraph> -<paragraph id="par_idm1341263552" role="bascode" localize="false" xml-lang="en-US"> sDir1 = "c:\Test"</paragraph> -<paragraph id="par_idm1341262320" role="bascode" localize="false" xml-lang="en-US"> sDir2 = "d:\Private"</paragraph> -<paragraph id="par_idm1341261072" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir1 )</paragraph> -<paragraph id="par_idm1341259840" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> -<paragraph id="par_idm1341258608" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir2 )</paragraph> -<paragraph id="par_idm1341257376" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> -<paragraph id="par_idm1341256144" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341266032" role="bascode" localize="false">Sub ExampleChDir</paragraph> +<paragraph id="par_idm1341264800" role="bascode" localize="false">Dim sDir1 As String , sDir2 As String</paragraph> +<paragraph id="par_idm1341263552" role="bascode" localize="false"> sDir1 = "c:\Test"</paragraph> +<paragraph id="par_idm1341262320" role="bascode" localize="false"> sDir2 = "d:\Private"</paragraph> +<paragraph id="par_idm1341261072" role="bascode" localize="false"> ChDir( sDir1 )</paragraph> +<paragraph id="par_idm1341259840" role="bascode" localize="false"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341258608" role="bascode" localize="false"> ChDir( sDir2 )</paragraph> +<paragraph id="par_idm1341257376" role="bascode" localize="false"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341256144" role="bascode" localize="false">End Sub</paragraph> </bascode> </body> diff --git a/source/text/sbasic/shared/03020402.xhp b/source/text/sbasic/shared/03020402.xhp index 21087ed3e..59f89e055 100644 --- a/source/text/sbasic/shared/03020402.xhp +++ b/source/text/sbasic/shared/03020402.xhp @@ -27,24 +27,22 @@ <body> - <section id="chdrive"> <bookmark xml-lang="en-US" branch="index" id="bm_id3145068"> <bookmark_value>ChDrive statement</bookmark_value> </bookmark> - -<paragraph id="hd_id3145068" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020402.xhp" name="ChDrive Statement">ChDrive Statement</link></paragraph> +<h1 id="hd_id3145068" xml-lang="en-US"><link href="text/sbasic/shared/03020402.xhp" name="ChDrive Statement">ChDrive Statement</link></h1> <paragraph id="par_id3149656" role="paragraph" xml-lang="en-US">Changes the current drive.</paragraph> </section> -<embed href="text/sbasic/shared/03020401.xhp#i30692"/> +<embed href="text/sbasic/shared/03020401.xhp#deprecated_inStarOffice7"/> -<paragraph id="hd_id3154138" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <bascode> <paragraph id="par_id3154685" role="bascode" xml-lang="en-US">ChDrive Text As String</paragraph> </bascode> -<paragraph id="hd_id3156423" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> <paragraph id="par_id3145172" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that contains the drive letter of the new drive. If you want, you can use <link href="text/sbasic/shared/00000002.xhp" name="URL notation">URL notation</link>.</paragraph> <paragraph id="par_id3145785" role="paragraph" xml-lang="en-US">The drive must be assigned a capital letter. Under Windows, the letter that you assign the drive is restricted by the settings in LASTDRV. If the drive argument is a multiple-character string, only the first letter is relevant. If you attempt to access a non-existent drive, an error occurs that you can respond to with the OnError statement.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> @@ -52,7 +50,7 @@ <embed href="text/sbasic/shared/00000003.xhp#err68"/> <embed href="text/sbasic/shared/00000003.xhp#err76"/> -<paragraph id="hd_id3153188" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> <bascode> <paragraph id="par_idm1340928496" role="bascode" localize="false" xml-lang="en-US">Sub ExampleChDrive</paragraph> <paragraph id="par_id3152576" role="bascode" xml-lang="en-US"> ChDrive "D" ' Only possible if a drive 'D' exists.</paragraph> diff --git a/source/text/sbasic/shared/03020403.xhp b/source/text/sbasic/shared/03020403.xhp index c238a5d1e..af7c1b381 100644 --- a/source/text/sbasic/shared/03020403.xhp +++ b/source/text/sbasic/shared/03020403.xhp @@ -27,29 +27,28 @@ <body> - <section id="curdir"> <bookmark xml-lang="en-US" branch="index" id="bm_id3153126"> <bookmark_value>CurDir function</bookmark_value> </bookmark> - -<paragraph id="hd_id3153126" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03020403.xhp">CurDir Function</link></paragraph> -<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns a variant string that represents the current path of the specified drive.</paragraph> +<h1 id="hd_id3153126" xml-lang="en-US"><variable id="CurDir_h1"><link href="text/sbasic/shared/03020403.xhp">CurDir Function</link></variable></h1> +<paragraph id="par_id3156343" role="paragraph" xml-lang="en-US">Returns a variant string that represents the current path <switchinline select="sys"><caseinline select="WIN">or that of the specified Windows drive</caseinline></switchinline>.</paragraph> </section> -<embed href="text/sbasic/shared/03020401.xhp#i30692"/> +<embed href="text/sbasic/shared/03020401.xhp#deprecated_inStarOffice7"/> -<paragraph id="hd_id3149457" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> <bascode> -<paragraph id="par_id3153381" role="bascode" xml-lang="en-US">CurDir [(Text As String)]</paragraph> +<paragraph id="par_id3153381" role="bascode" localize="false">CurDir [(Text As String)]</paragraph> </bascode> <paragraph id="hd_id3154366" role="heading" level="2" xml-lang="en-US">Return value:</paragraph> <paragraph id="par_id3156281" role="paragraph" xml-lang="en-US">String</paragraph> -<paragraph id="hd_id3156423" role="heading" level="2" xml-lang="en-US">Parameters:</paragraph> -<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies an existing drive (for example, "C" for the first partition of the first hard drive).</paragraph> -<paragraph id="par_id3155133" role="paragraph" xml-lang="en-US">If no drive is specified or if the drive is a zero-length string (""), CurDir returns the path for the current drive. $[officename] Basic reports an error if the syntax of the drive description is incorrect, the drive does not exist, or if the drive letter occurs after the letter defined in the CONFIG.SYS with the Lastdrive statement.</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functparameters"/> +<paragraph id="par_id3153193" role="paragraph" xml-lang="en-US"> <emph>Text:</emph> Any string expression that specifies an existing drive, for example "C" for the first partition of the first hard drive. This parameter is used solely under Windows.</paragraph> +<paragraph id="par_id3155133" role="paragraph" xml-lang="en-US">If no drive is specified or if the drive is a zero-length string (""), <literal>CurDir</literal> returns the path for the current drive. %PRODUCTNAME Basic reports an error if the syntax of the drive description is incorrect or if the drive does not exist.</paragraph> + <paragraph id="par_id3150010" role="paragraph" xml-lang="en-US">This function is not case-sensitive.</paragraph> <embed href="text/sbasic/shared/00000003.xhp#errorcode"/> <embed href="text/sbasic/shared/00000003.xhp#err5"/> @@ -57,18 +56,18 @@ <embed href="text/sbasic/shared/00000003.xhp#err7"/> <embed href="text/sbasic/shared/00000003.xhp#err51"/> -<paragraph id="hd_id3155411" role="heading" level="2" xml-lang="en-US">Example:</paragraph> +<embed href="text/sbasic/shared/00000003.xhp#functexample"/> <bascode> -<paragraph id="par_idm1341570656" role="bascode" localize="false" xml-lang="en-US">Sub ExampleCurDir</paragraph> -<paragraph id="par_idm1341569424" role="bascode" localize="false" xml-lang="en-US">Dim sDir1 As String , sDir2 As String</paragraph> -<paragraph id="par_idm1341568176" role="bascode" localize="false" xml-lang="en-US"> sDir1 = "c:\Test"</paragraph> -<paragraph id="par_idm1341566944" role="bascode" localize="false" xml-lang="en-US"> sDir2 = "d:\Private"</paragraph> -<paragraph id="par_idm1341565696" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir1 )</paragraph> -<paragraph id="par_idm1341564464" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> -<paragraph id="par_idm1341563232" role="bascode" localize="false" xml-lang="en-US"> ChDir( sDir2 )</paragraph> -<paragraph id="par_idm1341562000" role="bascode" localize="false" xml-lang="en-US"> MsgBox CurDir</paragraph> -<paragraph id="par_idm1341560768" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph> +<paragraph id="par_idm1341570656" role="bascode" localize="false">Sub ExampleCurDir</paragraph> +<paragraph id="par_idm1341569424" role="bascode" localize="false">Dim sDir1 As String , sDir2 As String</paragraph> +<paragraph id="par_idm1341568176" role="bascode" localize="false"> sDir1 = "c:\Test"</paragraph> +<paragraph id="par_idm1341566944" role="bascode" localize="false"> sDir2 = "d:\Private"</paragraph> +<paragraph id="par_idm1341565696" role="bascode" localize="false"> ChDir( sDir1 )</paragraph> +<paragraph id="par_idm1341564464" role="bascode" localize="false"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341563232" role="bascode" localize="false"> ChDir( sDir2 )</paragraph> +<paragraph id="par_idm1341562000" role="bascode" localize="false"> MsgBox CurDir</paragraph> +<paragraph id="par_idm1341560768" role="bascode" localize="false">End Sub</paragraph> </bascode> -</body> +</body> </helpdocument> \ No newline at end of file diff --git a/source/text/sbasic/shared/03020404.xhp b/source/text/sbasic/shared/03020404.xhp index 7a763a9f2..5416578ca 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 <> "." And sValue <> ".." Then</paragraph> -<paragraph id="par_idm1341550000" role="bascode" localize="false" xml-lang="en-US"> If (GetAttr( sPath + getPathSeparator + sValue) And 16) >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 <> "." 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" xml-lang="en-US"> sDir = sDir & chr(13) & 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 & 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> _______________________________________________ Libreoffice-commits mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/libreoffice-commits
