helpcontent2/source/text/sbasic/shared/03090403.xhp

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