offapi/com/sun/star/util/Endianness.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_util_Endianness_idl__
  28 #define __com_sun_star_util_Endianness_idl__
  29
  30 module com { module sun { module star { module util {
  31
  32 /** These constans describe the endiannes of data structures.<p>
  33
  34     The endianness specifies the order in which the bytes of larger
  35     types are laid out in memory.<p>
  36
  37     @since OOo 2.0.0
  38  */
  39 constants Endianness
  40 {
  41     /** Little endian.<p>
  42
  43         The values are stored in little endian format, i.e. the bytes
  44         of the long word 0xAABBCCDD are layed out like 0xDD, 0xCC,
  45         0xBB, 0xAA in memory. That is, data of arbitrary machine word
  46         lengths always starts with the least significant byte, and
  47         ends with the most significant one.<p>
  48      */
  49     const byte  LITTLE=0;
  50
  51     /** Big endian.<p>
  52
  53         The values are stored in big endian format, i.e. the bytes of
  54         the long word 0xAABBCCDD are layed out like 0xAA, 0xBB, 0xCC,
  55         0xDD in memory. That is, data of arbitrary machine word
  56         lengths always start with the most significant byte, and ends
  57         with the least significant one.<p>
  58      */
  59     const byte BIG=1;
  60 };
  61
  62 }; }; }; };
  63
  64 #endif