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