Files
help/source/text/sbasic/shared/03020401.xhp
Rafael Lima bd3e4888b2 Related tdf#128784 X-ref ChDir, ChDrive and CurDir with SF_FileSystem
The Basic functions ChDir, ChDrive and CurDir are DOS-specific and have limited functionality.

Hence, it's important to introduce the FileSystem service (from ScriptForge) for users that wish to write scripts that need to handle folders and files.

Change-Id: I33e24669083887b540cf44711ec5114e6ae5c521
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/115513
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romedenne@libreoffice.org>
2021-05-20 18:24:15 +02:00

78 lines
4.4 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="textsbasicshared03020401xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">ChDir Statement</title>
<filename>/text/sbasic/shared/03020401.xhp</filename>
</topic>
</meta>
<body>
<section id="chdir">
<bookmark xml-lang="en-US" branch="index" id="bm_id3150178">
<bookmark_value>ChDir statement</bookmark_value>
</bookmark>
<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="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>
<section id="SF_FileSystem_Note">
<note id="par_id321620859565917">The <link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="SF_Lib">ScriptForge</link> library in %PRODUCTNAME 7.1 introduces the <link href="text/sbasic/shared/03/sf_filesystem.xhp" name="FileSystem_Service">FileSystem</link> service with methods to handle files and folders in user scripts.</note>
</section>
<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>
<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"/>
<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<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>
<section id="relatedtopics">
<embed href="text/sbasic/shared/03/sf_filesystem.xhp#FileSystemService"/>
<embed href="text/sbasic/shared/03/sf_textstream.xhp#TextStreamService"/>
</section>
</body>
</helpdocument>