51Degrees Device Detection C/C++  4.1

A device detection library that is used natively or by 51Degrees products

value.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2019 51 Degrees Mobile Experts Limited, 5 Charlotte Close,
4  * Caversham, Reading, Berkshire, United Kingdom RG4 7BY.
5  *
6  * This Original Work is licensed under the European Union Public Licence (EUPL)
7  * v.1.2 and is subject to its terms as set out below.
8  *
9  * If a copy of the EUPL was not distributed with this file, You can obtain
10  * one at https://opensource.org/licenses/EUPL-1.2.
11  *
12  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13  * amended by the European Commission) shall be deemed incompatible for
14  * the purposes of the Work and the provisions of the compatibility
15  * clause in Article 5 of the EUPL shall not apply.
16  *
17  * If using the Work as, or as part of, a network application, by
18  * including the attribution notice(s) required under Article 5 of the EUPL
19  * in the end user terms of the application under an appropriate heading,
20  * such notice(s) shall fulfill the requirements of that article.
21  * ********************************************************************* */
22 
23 #ifndef FIFTYONE_DEGREES_PROPERTY_VALUE_H_INCLUDED
24 #define FIFTYONE_DEGREES_PROPERTY_VALUE_H_INCLUDED
25 
54 #include <stdint.h>
55 #ifdef _MSC_VER
56 #include <windows.h>
57 #endif
58 #include "data.h"
59 #include "exceptions.h"
60 #include "collection.h"
61 #include "string.h"
62 #include "property.h"
63 #include "profile.h"
64 
65 #ifdef __cplusplus
66 #define EXTERNAL extern "C"
67 #else
68 #define EXTERNAL
69 #endif
70 
72 #pragma pack(push, 2)
73 typedef struct fiftyoneDegrees_value_t {
74  const int16_t propertyIndex;
75  const int32_t nameOffset;
77  const int32_t descriptionOffset;
79  const int32_t urlOffset;
82 #pragma pack(pop)
83 
97  fiftyoneDegreesValue *value,
99  fiftyoneDegreesException *exception);
100 
113  fiftyoneDegreesCollection *strings,
114  fiftyoneDegreesValue *value,
116  fiftyoneDegreesException *exception);
117 
130  fiftyoneDegreesCollection *strings,
131  fiftyoneDegreesValue *value,
133  fiftyoneDegreesException *exception);
134 
146  uint32_t valueIndex,
148  fiftyoneDegreesException *exception);
149 
163  fiftyoneDegreesCollection *strings,
164  fiftyoneDegreesProperty *property,
165  const char *valueName,
167  fiftyoneDegreesException *exception);
168 
181  fiftyoneDegreesCollection *strings,
182  fiftyoneDegreesProperty *property,
183  const char *valueName,
184  fiftyoneDegreesException *exception);
185 
190 #endif
const int32_t urlOffset
The offset in the strings structure to the value URL.
Definition: value.h:79
fiftyoneDegreesString * fiftyoneDegreesValueGetName(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string name of the value using the item provided.
fiftyoneDegreesString * fiftyoneDegreesValueGetUrl(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string URL of the value using the item provided.
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:309
String structure containing its value and size.
Definition: string.h:87
fiftyoneDegreesValue * fiftyoneDegreesValueGet(fiftyoneDegreesCollection *values, uint32_t valueIndex, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the value for the requested index from the collection provided.
const int32_t nameOffset
The offset in the strings structure to the value name.
Definition: value.h:75
Value structure containing meta data relating to the value.
Definition: value.h:73
Property structure containing all the meta data relating to a property.
Definition: property.h:82
fiftyoneDegreesValue * fiftyoneDegreesValueGetByName(fiftyoneDegreesCollection *values, fiftyoneDegreesCollection *strings, fiftyoneDegreesProperty *property, const char *valueName, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Get the value for the requested name from the collection provided.
const int16_t propertyIndex
Index of the property the value relates to.
Definition: value.h:74
const int32_t descriptionOffset
The offset in the strings structure to the value description.
Definition: value.h:77
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:116
long fiftyoneDegreesValueGetIndexByName(fiftyoneDegreesCollection *values, fiftyoneDegreesCollection *strings, fiftyoneDegreesProperty *property, const char *valueName, fiftyoneDegreesException *exception)
Get index of the value for the requested name from the collection provided.
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:407
fiftyoneDegreesString * fiftyoneDegreesValueGetDescription(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string description of the value using the item provided.