dspal_version.h
3.03 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/****************************************************************************
* Copyright (c) 2016 James Wilson. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name ATLFlight nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#pragma once
/**
* @file
* API to retrieve the current version of the DSPAL API.
*/
#include "noarch/dspal_version_types.h"
/**
* Returns version information strings formatted as key/value pairs in each
* of the out variables defined below.
* @param out_version_string
* The version information of the DSPAL implementation currently in use, formatted as a key/value pair:
* DSPAL_VERSION_STRING=[major.minor.update.build_number]. May be left NULL.
* e.g.: DSPAL_VERSION_STRING=DSPAL-1.0.1.4242
* @param out_build_date
* The build date of the DSPAL implementation currently in use, formatted as a key/value pair:
* DSPAL_DATE_STRING=[Mmm dd yyyy]. May be left NULL.
* e.g.: DSPAL_DATE_STRING=Jan 01 2016
* @param out_build_time
* The build time of the DSPAL implementation currently in use, formatted as a key/value pair:
* BUILD_TIME_STRING=[hh:mm:ss]. May be left NULL.
* e.g.: BUILD_TIME_STRING=[23:59:01]
*/
void dspal_get_version_info(char *out_version_string, char *out_build_date, char *out_build_time);
/**
* @brief
* Returns version information strings formatted as key/value
* pairs inside the dispal_version_info structure
*
* @param out_version_info
* version information structure, each member will be populated
* according to structure description
*/
void dspal_get_version_info_ext(struct dspal_version_info *out_version_info);