1<?xml version="1.0" encoding="UTF-8"?> 2 3 4<!--*********************************************************************** 5 * 6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 7 * 8 * Copyright 2000, 2010 Oracle and/or its affiliates. 9 * 10 * OpenOffice.org - a multi-platform office productivity suite 11 * 12 * This file is part of OpenOffice.org. 13 * 14 * OpenOffice.org is free software: you can redistribute it and/or modify 15 * it under the terms of the GNU Lesser General Public License version 3 16 * only, as published by the Free Software Foundation. 17 * 18 * OpenOffice.org is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU Lesser General Public License version 3 for more details 22 * (a copy is included in the LICENSE file that accompanied this code). 23 * 24 * You should have received a copy of the GNU Lesser General Public License 25 * version 3 along with OpenOffice.org. If not, see 26 * <http://www.openoffice.org/license.html> 27 * for a copy of the LGPLv3 License. 28 * 29 ************************************************************************--> 30 31<helpdocument version="1.0"> 32<meta> 33<topic id="textsbasicshared03090403xml" indexer="include" status="PUBLISH"> 34<title id="tit" xml-lang="en-US">Declare Statement [Runtime]</title> 35<filename>/text/sbasic/shared/03090403.xhp</filename> 36</topic> 37<history> 38<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 39<lastedited date="2005-02-10T10:42:25">converted from old format - fpe</lastedited> 40</history> 41</meta> 42<body> 43<section id="declare"> 44<bookmark xml-lang="en-US" branch="index" id="bm_id3148473"><bookmark_value>Declare statement</bookmark_value> 45</bookmark> 46<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> 47<bookmark xml-lang="en-US" branch="index" id="bm_id3145316"><bookmark_value>DLL (Dynamic Link Library)</bookmark_value> 48</bookmark> 49<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> 50</section> 51<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> 52<paragraph role="heading" id="hd_id3156344" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph> 53<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> 54<paragraph role="heading" id="hd_id3153360" xml-lang="en-US" level="2" l10n="U" oldref="6">Parameters:</paragraph> 55<paragraph role="paragraph" id="par_id3154140" xml-lang="en-US" l10n="U" oldref="8"> 56<emph>Name:</emph> A different name than defined in the DLL, to call the subroutine from $[officename] Basic.</paragraph> 57<paragraph role="paragraph" id="par_id3150870" xml-lang="en-US" l10n="U" oldref="9"> 58<emph>Aliasname</emph>: Name of the subroutine as defined in the DLL.</paragraph> 59<paragraph role="paragraph" id="par_id3154684" xml-lang="en-US" l10n="U" oldref="10"> 60<emph>Libname:</emph> File or system name of the DLL. This library is automatically loaded the first time the function is used.</paragraph> 61<paragraph role="paragraph" id="par_id3148452" xml-lang="en-US" l10n="U" oldref="11"> 62<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> 63<paragraph role="paragraph" id="par_id3147289" xml-lang="en-US" l10n="U" oldref="12"> 64<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> 65<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> 66<paragraph role="heading" id="hd_id3153951" xml-lang="en-US" level="2" l10n="U" oldref="14">Example:</paragraph> 67<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US" l10n="U" oldref="15">Declare Sub MyMessageBeep Lib "user32.dll" Alias "MessageBeep" ( long )</paragraph> 68<paragraph role="paragraph" id="par_id3150417" xml-lang="en-US" l10n="U" oldref="17">Sub ExampleDeclare</paragraph> 69<paragraph role="paragraph" id="par_id3149959" xml-lang="en-US" l10n="U" oldref="18">Dim lValue As Long</paragraph> 70<paragraph role="paragraph" id="par_id3145647" xml-lang="en-US" l10n="U" oldref="19">lValue = 5000</paragraph> 71<paragraph role="paragraph" id="par_id3145801" xml-lang="en-US" l10n="U" oldref="20">MyMessageBeep( lValue )</paragraph> 72<paragraph role="paragraph" id="par_id3145253" xml-lang="en-US" l10n="U" oldref="21">FreeLibrary("user32.dll" )</paragraph> 73<paragraph role="paragraph" id="par_id3149402" xml-lang="en-US" l10n="U" oldref="22">End Sub</paragraph> 74</body> 75</helpdocument> 76