forked from amazingfate/help
« 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>
73 lines
4.1 KiB
XML
73 lines
4.1 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="textsbasicshared03020403xml" indexer="include" status="PUBLISH">
|
|
<title id="tit" xml-lang="en-US">CurDir Function</title>
|
|
<filename>/text/sbasic/shared/03020403.xhp</filename>
|
|
</topic>
|
|
</meta>
|
|
|
|
<body>
|
|
|
|
<section id="curdir">
|
|
<bookmark xml-lang="en-US" branch="index" id="bm_id3153126">
|
|
<bookmark_value>CurDir function</bookmark_value>
|
|
</bookmark>
|
|
|
|
<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#deprecated_inStarOffice7"/>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
|
|
<bascode>
|
|
<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>
|
|
|
|
<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"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err68"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err7"/>
|
|
<embed href="text/sbasic/shared/00000003.xhp#err51"/>
|
|
|
|
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
|
|
<bascode>
|
|
<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>
|
|
</helpdocument> |