1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--***********************************************************
4 *
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements.  See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership.  The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License.  You may obtain a copy of the License at
12 *
13 *   http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied.  See the License for the
19 * specific language governing permissions and limitations
20 * under the License.
21 *
22 ***********************************************************-->
23
24<helpdocument version="1.0">
25<meta>
26<topic id="textsbasicshared03090403xml" indexer="include" status="PUBLISH">
27<title id="tit" xml-lang="en-US">Declare Statement [Runtime]</title>
28<filename>/text/sbasic/shared/03090403.xhp</filename>
29</topic>
30</meta>
31<body>
32<section id="declare">
33<bookmark xml-lang="en-US" branch="index" id="bm_id3148473">
34<bookmark_value>Declare statement</bookmark_value>
35</bookmark>
36<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03090403.xhp" name="Declare Statement [Runtime]">Declare Statement [Runtime]</link></paragraph>
37<bookmark xml-lang="en-US" branch="index" id="bm_id3145316">
38<bookmark_value>DLL (Dynamic Link Library)</bookmark_value>
39</bookmark>
40<paragraph role="paragraph" id="par_id3145316" xml-lang="en-US" l10n="CHG" oldref="2">Declares and defines a subroutine in a DLL file that you want to execute from $[officename] Basic.</paragraph>
41</section>
42<paragraph role="paragraph" id="par_id3146795" xml-lang="en-US" l10n="U" oldref="3">See also: <link href="text/sbasic/shared/03090405.xhp" name="FreeLibrary">FreeLibrary</link></paragraph>
43<paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
44<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="5">Declare {Sub | Function} Name Lib "Libname" [Alias "Aliasname"] [Parameter] [As Type]</paragraph>
45<paragraph role="heading" id="hd_id3153360" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameters:</paragraph>
46<paragraph role="paragraph" id="par_id3154140" xml-lang="en-US" l10n="U" oldref="8">
47<emph>Name:</emph> A different name than defined in the DLL, to call the subroutine from $[officename] Basic.</paragraph>
48<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US" l10n="U" oldref="9">
49<emph>Aliasname:</emph> Name of the subroutine as defined in the DLL.</paragraph>
50<paragraph role="paragraph" id="par_id3154684" xml-lang="en-US" l10n="U" oldref="10">
51<emph>Libname:</emph> File or system name of the DLL. This library is automatically loaded the first time the function is used.</paragraph>
52<paragraph role="paragraph" id="par_id3148452" xml-lang="en-US" l10n="U" oldref="11">
53<emph>Argumentlist:</emph> List of parameters representing arguments that are passed to the procedure when it is called. The type and number of parameters is dependent on the executed procedure.</paragraph>
54<paragraph role="paragraph" id="par_id3147289" xml-lang="en-US" l10n="U" oldref="12">
55<emph>Type:</emph> Defines the data type of the value that is returned by a function procedure. You can exclude this parameter if a type-declaration character is entered after the name.</paragraph>
56<paragraph role="warning" id="par_id3146922" xml-lang="en-US" l10n="U" oldref="13">To pass a parameter to a subroutine as a value instead of as a reference, the parameter must be indicated by the keyword <emph>ByVal</emph>.</paragraph>
57<paragraph role="heading" id="hd_id3153951" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph>
58<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US" l10n="U" oldref="15">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( long )</paragraph>
59<paragraph role="paragraph" id="par_id3150417" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleDeclare</paragraph>
60<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="18">Dim lValue As Long</paragraph>
61<paragraph role="paragraph" id="par_id3145647" xml-lang="en-US" l10n="U" oldref="19">lValue = 5000</paragraph>
62<paragraph role="paragraph" id="par_id3145801" xml-lang="en-US" l10n="U" oldref="20">MyMessageBeep( lValue )</paragraph>
63<paragraph role="paragraph" id="par_id3145253" xml-lang="en-US" l10n="U" oldref="21">FreeLibrary("user32.dll" )</paragraph>
64<paragraph role="paragraph" id="par_id3149402" xml-lang="en-US" l10n="U" oldref="22">End Sub</paragraph>
65</body>
66</helpdocument>
67