\r\n

51Degrees Device Detection C/C++  4.4

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 2023 51 Degrees Mobile Experts Limited, Davidson House,
4  * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
5  *
6  * This Original Work is licensed under the European Union Public Licence
7  * (EUPL) 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 #pragma warning (push)
57 #pragma warning (disable: 5105)
58 #include <windows.h>
59 #pragma warning (default: 5105)
60 #pragma warning (pop)
61 #endif
62 #include "data.h"
63 #include "exceptions.h"
64 #include "collection.h"
65 #include "string.h"
66 #include "property.h"
67 #include "profile.h"
68 #include "common.h"
69 
71 #pragma pack(push, 2)
72 typedef struct fiftyoneDegrees_value_t {
73  const int16_t propertyIndex;
74  const int32_t nameOffset;
76  const int32_t descriptionOffset;
78  const int32_t urlOffset;
80 } fiftyoneDegreesValue;
81 #pragma pack(pop)
82 
94 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesValueGetName(
95  fiftyoneDegreesCollection *strings,
96  fiftyoneDegreesValue *value,
97  fiftyoneDegreesCollectionItem *item,
98  fiftyoneDegreesException *exception);
99 
111 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesValueGetDescription(
112  fiftyoneDegreesCollection *strings,
113  fiftyoneDegreesValue *value,
114  fiftyoneDegreesCollectionItem *item,
115  fiftyoneDegreesException *exception);
116 
128 EXTERNAL fiftyoneDegreesString* fiftyoneDegreesValueGetUrl(
129  fiftyoneDegreesCollection *strings,
130  fiftyoneDegreesValue *value,
131  fiftyoneDegreesCollectionItem *item,
132  fiftyoneDegreesException *exception);
133 
143 EXTERNAL fiftyoneDegreesValue* fiftyoneDegreesValueGet(
144  fiftyoneDegreesCollection *values,
145  uint32_t valueIndex,
146  fiftyoneDegreesCollectionItem *item,
147  fiftyoneDegreesException *exception);
148 
160 EXTERNAL fiftyoneDegreesValue* fiftyoneDegreesValueGetByName(
161  fiftyoneDegreesCollection *values,
162  fiftyoneDegreesCollection *strings,
163  fiftyoneDegreesProperty *property,
164  const char *valueName,
165  fiftyoneDegreesCollectionItem *item,
166  fiftyoneDegreesException *exception);
167 
178 EXTERNAL long fiftyoneDegreesValueGetIndexByName(
179  fiftyoneDegreesCollection *values,
180  fiftyoneDegreesCollection *strings,
181  fiftyoneDegreesProperty *property,
182  const char *valueName,
183  fiftyoneDegreesException *exception);
184 
189 #endif
fiftyoneDegreesValue::urlOffset
const int32_t urlOffset
The offset in the strings structure to the value URL.
Definition: value.h:78
fiftyoneDegreesValueGetName
fiftyoneDegreesString * fiftyoneDegreesValueGetName(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string name of the value using the item provided.
fiftyoneDegreesValueGetUrl
fiftyoneDegreesString * fiftyoneDegreesValueGetUrl(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string URL of the value using the item provided.
fiftyoneDegreesCollectionItem
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:308
fiftyoneDegreesString
String structure containing its value and size.
Definition: string.h:109
fiftyoneDegreesValueGet
fiftyoneDegreesValue * fiftyoneDegreesValueGet(fiftyoneDegreesCollection *values, uint32_t valueIndex, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the value for the requested index from the collection provided.
fiftyoneDegreesValue::nameOffset
const int32_t nameOffset
The offset in the strings structure to the value name.
Definition: value.h:74
fiftyoneDegreesValue
Value structure containing meta data relating to the value.
Definition: value.h:72
fiftyoneDegreesProperty
Property structure containing all the meta data relating to a property.
Definition: property.h:85
fiftyoneDegreesValueGetByName
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.
fiftyoneDegreesValue::propertyIndex
const int16_t propertyIndex
Index of the property the value relates to.
Definition: value.h:73
fiftyoneDegreesValue::descriptionOffset
const int32_t descriptionOffset
The offset in the strings structure to the value description.
Definition: value.h:76
fiftyoneDegreesException
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:111
fiftyoneDegreesValueGetIndexByName
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.
fiftyoneDegreesCollection
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:408
fiftyoneDegreesValueGetDescription
fiftyoneDegreesString * fiftyoneDegreesValueGetDescription(fiftyoneDegreesCollection *strings, fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string description of the value using the item provided.

Generated by doxygen 1.8.15