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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module bridge {  module oleautomation {
  22
  23 /** <p>is the UNO representation of the Automation type SCODE.
  24     </p>
  25     <p>
  26     A <code>SCODE</code> is used to express errors in Automation.
  27     In UNO it could be represented by a `long` and therefore a typedef
  28     from `long` to a particular error type  would do. But a typedef
  29     cannot be expressed in all language bindings. In the case where no typedefs
  30     are supported the actual type is used. That is, a typedef'd error type would
  31     be represented as <code>int</code> in Java. The information that the
  32     <code>int</code> is an error type is lost.
  33     </p>
  34     <p>
  35     When calling Automation objects from UNO the distinction between error type
  36     and `long` is important. Therefore the Scode is
  37     declared as struct.
  38     </p>
  39
  40     @since OOo 1.1.2
  41  */
  42
  43
  44 struct SCode
  45 {
  46     long Value;
  47 };
  48
  49 }; }; }; }; };
  50
  51
  52 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */