1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?>
2*b1cdbd2cSJim Jagielski
3*b1cdbd2cSJim Jagielski
4*b1cdbd2cSJim Jagielski<!--***********************************************************
5*b1cdbd2cSJim Jagielski *
6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
7*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
8*b1cdbd2cSJim Jagielski * distributed with this work for additional information
9*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
12*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
13*b1cdbd2cSJim Jagielski *
14*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
15*b1cdbd2cSJim Jagielski *
16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
21*b1cdbd2cSJim Jagielski * under the License.
22*b1cdbd2cSJim Jagielski *
23*b1cdbd2cSJim Jagielski ***********************************************************-->
24*b1cdbd2cSJim Jagielski
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski<helpdocument version="1.0">
28*b1cdbd2cSJim Jagielski<meta>
29*b1cdbd2cSJim Jagielski<topic id="textsbasicshared03090403xml" indexer="include" status="PUBLISH">
30*b1cdbd2cSJim Jagielski<title id="tit" xml-lang="en-US">Declare Statement [Runtime]</title>
31*b1cdbd2cSJim Jagielski<filename>/text/sbasic/shared/03090403.xhp</filename>
32*b1cdbd2cSJim Jagielski</topic>
33*b1cdbd2cSJim Jagielski<history>
34*b1cdbd2cSJim Jagielski<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
35*b1cdbd2cSJim Jagielski<lastedited date="2005-02-10T10:42:25">converted from old format - fpe</lastedited>
36*b1cdbd2cSJim Jagielski</history>
37*b1cdbd2cSJim Jagielski</meta>
38*b1cdbd2cSJim Jagielski<body>
39*b1cdbd2cSJim Jagielski<section id="declare">
40*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3148473"><bookmark_value>Declare statement</bookmark_value>
41*b1cdbd2cSJim Jagielski</bookmark>
42*b1cdbd2cSJim Jagielski<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>
43*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3145316"><bookmark_value>DLL (Dynamic Link Library)</bookmark_value>
44*b1cdbd2cSJim Jagielski</bookmark>
45*b1cdbd2cSJim Jagielski<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>
46*b1cdbd2cSJim Jagielski</section>
47*b1cdbd2cSJim Jagielski<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>
48*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
49*b1cdbd2cSJim Jagielski<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>
50*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3153360" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameters:</paragraph>
51*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154140" xml-lang="en-US" l10n="U" oldref="8">
52*b1cdbd2cSJim Jagielski<emph>Name:</emph> A different name than defined in the DLL, to call the subroutine from $[officename] Basic.</paragraph>
53*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US" l10n="U" oldref="9">
54*b1cdbd2cSJim Jagielski<emph>Aliasname</emph>: Name of the subroutine as defined in the DLL.</paragraph>
55*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154684" xml-lang="en-US" l10n="U" oldref="10">
56*b1cdbd2cSJim Jagielski<emph>Libname:</emph> File or system name of the DLL. This library is automatically loaded the first time the function is used.</paragraph>
57*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3148452" xml-lang="en-US" l10n="U" oldref="11">
58*b1cdbd2cSJim Jagielski<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>
59*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3147289" xml-lang="en-US" l10n="U" oldref="12">
60*b1cdbd2cSJim Jagielski<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>
61*b1cdbd2cSJim Jagielski<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>
62*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3153951" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph>
63*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US" l10n="U" oldref="15">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( long )</paragraph>
64*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3150417" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleDeclare</paragraph>
65*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="18">Dim lValue As Long</paragraph>
66*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145647" xml-lang="en-US" l10n="U" oldref="19">lValue = 5000</paragraph>
67*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145801" xml-lang="en-US" l10n="U" oldref="20">MyMessageBeep( lValue )</paragraph>
68*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145253" xml-lang="en-US" l10n="U" oldref="21">FreeLibrary("user32.dll" )</paragraph>
69*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3149402" xml-lang="en-US" l10n="U" oldref="22">End Sub</paragraph>
70*b1cdbd2cSJim Jagielski</body>
71*b1cdbd2cSJim Jagielski</helpdocument>
72