blob: 993fb7c7a36111eabc7335722f4327b1175dfa54 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
***********************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03090403xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Declare Statement [Runtime]</title>
<filename>/text/sbasic/shared/03090403.xhp</filename>
</topic>
</meta>
<body>
<section id="declare">
<bookmark xml-lang="en-US" branch="index" id="bm_id3148473">
<bookmark_value>Declare statement</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3148473" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03090403.xhp" name="Declare Statement [Runtime]">Declare Statement [Runtime]</link></paragraph>
<bookmark xml-lang="en-US" branch="index" id="bm_id3145316">
<bookmark_value>DLL (Dynamic Link Library)</bookmark_value>
</bookmark>
<paragraph role="paragraph" id="par_id3145316" xml-lang="en-US" l10n="CHG">Declares and defines a subroutine in a DLL file that you want to execute from $[officename] Basic.</paragraph>
</section>
<paragraph role="paragraph" id="par_id3146795" xml-lang="en-US" l10n="U">See also: <link href="text/sbasic/shared/03090405.xhp" name="FreeLibrary">FreeLibrary</link></paragraph>
<paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
<paragraph role="paragraph" id="par_id3148664" xml-lang="en-US" l10n="U">Declare {Sub | Function} Name Lib "Libname" [Alias "Aliasname"] [Parameter] [As Type]</paragraph>
<paragraph role="heading" id="hd_id3153360" xml-lang="en-US" level="2" l10n="U">Parameters:</paragraph>
<paragraph role="paragraph" id="par_id3154140" xml-lang="en-US" l10n="U"><emph>Name:</emph> A different name than defined in the DLL, to call the subroutine from $[officename] Basic.</paragraph>
<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US" l10n="U"><emph>Aliasname:</emph> Name of the subroutine as defined in the DLL.</paragraph>
<paragraph role="paragraph" id="par_id3154684" xml-lang="en-US" l10n="U"><emph>Libname:</emph> File or system name of the DLL. This library is automatically loaded the first time the function is used.</paragraph>
<paragraph role="paragraph" id="par_id3148452" xml-lang="en-US" l10n="U"><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>
<paragraph role="paragraph" id="par_id3147289" xml-lang="en-US" l10n="U"><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>
<paragraph role="warning" id="par_id3146922" xml-lang="en-US" l10n="U">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>
<paragraph role="heading" id="hd_id3153951" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US" l10n="U">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( long )</paragraph>
<paragraph role="paragraph" id="par_id3150417" xml-lang="en-US" l10n="U">Sub ExampleDeclare</paragraph>
<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U">Dim lValue As Long</paragraph>
<paragraph role="paragraph" id="par_id3145647" xml-lang="en-US" l10n="U">lValue = 5000</paragraph>
<paragraph role="paragraph" id="par_id3145801" xml-lang="en-US" l10n="U">MyMessageBeep( lValue )</paragraph>
<paragraph role="paragraph" id="par_id3145253" xml-lang="en-US" l10n="U">FreeLibrary("user32.dll" )</paragraph>
<paragraph role="paragraph" id="par_id3149402" xml-lang="en-US" l10n="U">End Sub</paragraph>
</body>
</helpdocument>