udkapi/com/sun/star/bridge/oleautomation/NamedArgument.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NamedArgument.idl,v $
  10  * $Revision: 1.6 $
  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 #ifndef __com_sun_star_bridge_oleautomation_NamedArgument_idl__
  31 #define __com_sun_star_bridge_oleautomation_NamedArgument_idl__
  32
  33
  34 module com {  module sun {  module star {  module bridge {  module oleautomation {
  35
  36 /** represents a named argument in a call to a method of an Automation object.
  37     <p>
  38     The Automation bridge accepts values of <type>NamedArgument</type> when a
  39     call to an Automation object is made. The call is done through the
  40     <method scope="com::sun::star::script">XInvocation::invoke</method>
  41     method, which takes all arguments in a sequence of anys. Usually the order
  42     of the arguments must correspond to the order of arguments in the Automation
  43     method. By using instances of <type>NamedArgument</type> the arguments in the
  44     sequence can be unordered. The Automation object being called must support
  45     named arguments, otherwise the call fails.
  46     </p>
  47
  48     @since OOo 1.1.2
  49  */
  50 struct NamedArgument
  51 {
  52     /** The name of the argument, for which
  53         <member>NamedArgument::Value</member> is intended.
  54      */
  55     string Name;
  56
  57     /** The value of the argument whoose name is the one as contained in the
  58         member <member>Name</member>.
  59      */
  60     any Value;
  61 };
  62
  63 }; }; }; }; };
  64
  65
  66 #endif