VirtualBox

source: vbox/trunk/include/iprt/buildconfig.h@ 26558

Last change on this file since 26558 was 22563, checked in by vboxsync, 15 years ago

IPRT: Added a RTBldCfg API group for stuffing away the SVN_REV and version of the product IPRT is used by.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.7 KB
Line 
1/** @file
2 * IPRT - Build Configuration Information
3 */
4
5/*
6 * Copyright (C) 2009 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___iprt_buildconfig_h
31#define ___iprt_buildconfig_h
32
33#include <iprt/cdefs.h>
34#include <iprt/types.h>
35
36RT_C_DECLS_BEGIN
37
38/** @defgroup grp_rt_buildconfig RTBldCfg - Build Configuration Information
39 * @ingroup grp_rt
40 * @{
41 */
42
43/**
44 * Gets the source code management revision of the IPRT build.
45 * @returns Source code management revision number.
46 */
47RTDECL(uint32_t) RTBldCfgRevision(void);
48
49/**
50 * Gets the source code management revision of the IPRT build.
51 * @returns Read only string containing the revision number.
52 */
53RTDECL(const char *) RTBldCfgRevisionStr(void);
54
55/**
56 * Gets the product version string.
57 *
58 * This will be a string on the form "x.y.z[_string]".
59 *
60 * @returns Read only version string.
61 *
62 * @remarks This is a build time configuration thing that the product using IPRT
63 * will set. It is therefore not any IPRT version, but rather the
64 * version of that product.
65 */
66RTDECL(const char *) RTBldCfgVersion(void);
67
68/**
69 * Gets the major product version number.
70 * @returns Major product version number.
71 * @remarks See RTBldCfgVersion.
72 */
73RTDECL(uint32_t) RTBldCfgVersionMajor(void);
74
75/**
76 * Gets the minor product version number.
77 * @returns Minor product version number.
78 * @remarks See RTBldCfgVersion.
79 */
80RTDECL(uint32_t) RTBldCfgVersionMinor(void);
81
82/**
83 * Gets the product build number.
84 * @returns Product build number.
85 * @remarks See RTBldCfgVersion.
86 */
87RTDECL(uint32_t) RTBldCfgVersionBuild(void);
88
89
90/** @} */
91
92RT_C_DECLS_END
93
94#endif
95
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette