offapi/com/sun/star/util/Endianness.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: Endianness.idl,v $
  10  * $Revision: 1.2 $
  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_util_Endianness_idl__
  31 #define __com_sun_star_util_Endianness_idl__
  32
  33 module com { module sun { module star { module util {
  34
  35 /** These constans describe the endiannes of data structures.<p>
  36
  37     The endianness specifies the order in which the bytes of larger
  38     types are laid out in memory.<p>
  39
  40     @since OOo 2.0.0
  41  */
  42 constants Endianness
  43 {
  44     /** Little endian.<p>
  45
  46         The values are stored in little endian format, i.e. the bytes
  47         of the long word 0xAABBCCDD are layed out like 0xDD, 0xCC,
  48         0xBB, 0xAA in memory. That is, data of arbitrary machine word
  49         lengths always starts with the least significant byte, and
  50         ends with the most significant one.<p>
  51      */
  52     const byte  LITTLE=0;
  53
  54     /** Big endian.<p>
  55
  56         The values are stored in big endian format, i.e. the bytes of
  57         the long word 0xAABBCCDD are layed out like 0xAA, 0xBB, 0xCC,
  58         0xDD in memory. That is, data of arbitrary machine word
  59         lengths always start with the most significant byte, and ends
  60         with the least significant one.<p>
  61      */
  62     const byte BIG=1;
  63 };
  64
  65 }; }; }; };
  66
  67 #endif