source/text/sbasic/shared/compatibilitymode.xhp


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

<?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/.
    *
    -->
    <meta>
        <topic id="text/sbasic/shared/compatibilitymode">
            <title id="tit" xml-lang="en-US">CompatibilityMode function</title>
            <filename>/text/sbasic/shared/compatibilitymode.xhp</filename>
        </topic>
    </meta>
    <body>
    <bookmark branch="index" id="N0103">
        <bookmark_value>CompatibilityMode</bookmark_value>
        <bookmark_value>VBA compatibility mode</bookmark_value>
    </bookmark>
    <section id="compatibilitymodefunction">
        <h1 id="N0118"><variable id="compatibilitymodeh1"><link href="text/sbasic/shared/compatibilitymode.xhp" name="CompatibilityMode">CompatibilityMode() Function</link></variable></h1>
        <paragraph role="paragraph" id="N0120"><literal>CompatibilityMode()</literal> function is controlling runtime mode and affects all code executed after setting or resetting the mode. </paragraph>
        </section>
    <warning id="N0119">Use this feature with caution, limit it to document conversion for example.</warning>
    <note id="par_id271561645872679"><literal>Option Compatible</literal> turns on VBA compatibility at module level for the %PRODUCTNAME Basic interpreter.</note>
    <paragraph role="paragraph" id="N0121">This function may affect or help in the following situations:</paragraph>
    <list type="unordered">
        <listitem><paragraph role="listitem" id="N0122">Creating enumerations with <link href="text/sbasic/shared/enum.xhp" name="enum statement">Enum statement</link></paragraph></listitem>
        <listitem><paragraph role="listitem" id="N0124">Running <literal>RmDir</literal> command in VBA mode. In VBA only empty directories are removed by <literal>RmDir</literal> while %PRODUCTNAME Basic removes a directory recursively.</paragraph></listitem>
        <listitem><paragraph role="listitem" id="N0125">Changing behavior of Basic <literal>Dir</literal> command. The directory flag (16) for the <literal>Dir</literal> command means that only directories are returned in %PRODUCTNAME Basic, while in VBA normal files and directories are returned.</paragraph></listitem>
    </list>
    <note id="N0126"><literal>CompatibilityMode()</literal> function may be necessary when resorting to <literal>Option Compatible</literal> or <literal>Option VBASupport</literal> compiler modes.</note>
    <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
    <paragraph role="code" localize="false" id="N0128">CompatibilityMode(True | False)</paragraph>
    <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
    <paragraph role="paragraph" id="par_id541561646705787">Given a NOT empty directory at <emph>file:///home/me/Test</emph></paragraph>
    <bascode>
        <paragraph role="bascode" id="par_id491561646553280" xml-lang="en-US" localize="false">Sub RemoveDir</paragraph>
        <paragraph role="bascode" id="par_id771561646565613" xml-lang="en-US" localize="false">    CompatibilityMode( true )</paragraph>
        <paragraph role="bascode" id="par_id311561646572637" xml-lang="en-US" localize="false">    RmDir( "file:///home/me/Test" )</paragraph>
        <paragraph role="bascode" id="par_id851561646579895" xml-lang="en-US" localize="false">End Sub</paragraph>
   </bascode>
   <paragraph role="paragraph" id="par_id461561646613414">With <literal>CompatibilityMode( true )</literal> the program results in an error, otherwise the Test directory and all its content is deleted.</paragraph>
   <embed href="text/sbasic/shared/00000003.xhp#functexample"/>
   <paragraph role="paragraph" id="par_id411561647797398">Modifying <literal>Dir</literal> behavior</paragraph>
   <bascode>
    <paragraph role="bascode" id="par_id941561647889938" xml-lang="en-US" localize="false">Sub VBADirCommand</paragraph>
    <paragraph role="bascode" id="par_id831561647900147" xml-lang="en-US">    CompatibilityMode( true )   ' Shows also normal files</paragraph>
    <paragraph role="bascode" id="par_id931561647920869" xml-lang="en-US" localize="false">    Entry$ = Dir( "file:///home/me/Tmp/*.*", 16 )</paragraph>
    <paragraph role="bascode" id="par_id31561647939939" xml-lang="en-US" localize="false">    Total$ = ""</paragraph>
    <paragraph role="bascode" id="par_id71561647964220" xml-lang="en-US" localize="false">    While Entry$ &lt;&gt; ""</paragraph>
    <paragraph role="bascode" id="par_id51561647969918" xml-lang="en-US" localize="false">        Total$ = Total$ + Entry$ + Chr$(13)</paragraph>
    <paragraph role="bascode" id="par_id111561647975134" xml-lang="en-US" localize="false">        Entry$ = Dir</paragraph>
    <paragraph role="bascode" id="par_id751561647979743" xml-lang="en-US" localize="false">    Wend</paragraph>
    <paragraph role="bascode" id="par_id401561647986945" xml-lang="en-US" localize="false">    MsgBox Total$</paragraph>
    <paragraph role="bascode" id="par_id111561647991525" xml-lang="en-US" localize="false">End Sub</paragraph>
    </bascode>

   <section id="relatedtopics">
        <embed href="text/sbasic/shared/compatible.xhp#compatiblestatement"/>
        <paragraph role="paragraph" id="N0129">
            Refer to <link href="text/sbasic/python/python_platform.xhp">Identifying the Operating System</link> and <link href="text/sbasic/python/python_session.xhp">Getting Session Information</link> for <literal>Option Compatible</literal> simple examples, or <link href="text/sbasic/guide/access2base.xhp">Access2Base shared Basic library</link> for other class examples making use of <literal>Option Compatible</literal> compiler mode.
        </paragraph>
        <embed href="text/sbasic/shared/03090407.xhp#remstatement"/>
        <paragraph role="paragraph" id="N0131">
            Variables scope modification in <link href="text/sbasic/shared/01020300.xhp">Using Procedures and Functions</link> with <literal>CompatibilityMode()</literal> function.
        </paragraph>
        <embed href="text/sbasic/shared/03103200.xhp#optionbasestatement"/>
        <embed href="text/sbasic/shared/03103300.xhp#explicitstatement"/>
        <embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/>
        <embed href="text/sbasic/shared/classmodule.xhp#classmodulestatement"/>
    </section>
</body>
</helpdocument>