source: trunk/src/corelib/global/qendian.qdoc@ 1023

Last change on this file since 1023 was 846, checked in by Dmitry A. Kuminov, 14 years ago

trunk: Merged in qt 4.7.2 sources from branches/vendor/nokia/qt.

  • Property svn:eol-style set to native
File size: 5.0 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the documentation of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:FDL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in a
14** written agreement between you and Nokia.
15**
16** GNU Free Documentation License
17** Alternatively, this file may be used under the terms of the GNU Free
18** Documentation License version 1.3 as published by the Free Software
19** Foundation and appearing in the file included in the packaging of this
20** file.
21**
22** If you have questions regarding the use of this file, please contact
23** Nokia at [email protected].
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29 \headerfile <QtEndian>
30 \title Endian Conversion Functions
31 \ingroup funclists
32 \brief The <QtEndian> header provides functions to convert between
33 little and big endian representations of numbers.
34*/
35
36/*!
37 \fn T qFromBigEndian(const uchar *src)
38 \since 4.3
39 \relates <QtEndian>
40
41 Reads a big-endian number from memory location \a src and returns the number in the
42 host byte order representation.
43 On CPU architectures where the host byte order is little-endian (such as x86) this
44 will swap the byte order; otherwise it will just read from \a src.
45
46 \note Template type \c{T} can either be a qint16, qint32 or qint64. Other types of
47 integers, e.g., qlong, are not applicable.
48
49 There are no data alignment constraints for \a src.
50
51 \sa qFromLittleEndian()
52 \sa qToBigEndian()
53 \sa qToLittleEndian()
54*/
55/*!
56 \fn T qFromBigEndian(T src)