\r\n

51Degrees Device Detection C/C++  4.5

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 "storedBinaryValue.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 
95 EXTERNAL const fiftyoneDegreesStoredBinaryValue* fiftyoneDegreesValueGetContent(
96  const fiftyoneDegreesCollection *strings,
97  const fiftyoneDegreesValue *value,
98  fiftyoneDegreesPropertyValueType storedValueType,
99  fiftyoneDegreesCollectionItem *item,
100  fiftyoneDegreesException *exception);
101 
113 EXTERNAL const fiftyoneDegreesString* fiftyoneDegreesValueGetName(
114  const fiftyoneDegreesCollection *strings,
115  const fiftyoneDegreesValue *value,
116  fiftyoneDegreesCollectionItem *item,
117  fiftyoneDegreesException *exception);
118 
130 EXTERNAL const fiftyoneDegreesString* fiftyoneDegreesValueGetDescription(
131  const fiftyoneDegreesCollection *strings,
132  const fiftyoneDegreesValue *value,
133  fiftyoneDegreesCollectionItem *item,
134  fiftyoneDegreesException *exception);
135 
147 EXTERNAL const fiftyoneDegreesString* fiftyoneDegreesValueGetUrl(
148  const fiftyoneDegreesCollection *strings,
149  const fiftyoneDegreesValue *value,
150  fiftyoneDegreesCollectionItem *item,
151  fiftyoneDegreesException *exception);
152 
162 EXTERNAL const fiftyoneDegreesValue* fiftyoneDegreesValueGet(
163  const fiftyoneDegreesCollection *values,
164  uint32_t valueIndex,
165  fiftyoneDegreesCollectionItem *item,
166  fiftyoneDegreesException *exception);
167 
180 EXTERNAL const fiftyoneDegreesValue* fiftyoneDegreesValueGetByNameAndType(
181  const fiftyoneDegreesCollection *values,
182  const fiftyoneDegreesCollection *strings,
183  const fiftyoneDegreesProperty *property,
184  fiftyoneDegreesPropertyValueType storedValueType,
185  const char *valueName,
186  fiftyoneDegreesCollectionItem *item,
187  fiftyoneDegreesException *exception);
188 
200 EXTERNAL const fiftyoneDegreesValue* fiftyoneDegreesValueGetByName(
201  const fiftyoneDegreesCollection *values,
202  const fiftyoneDegreesCollection *strings,
203  const fiftyoneDegreesProperty *property,
204  const char *valueName,
205  fiftyoneDegreesCollectionItem *item,
206  fiftyoneDegreesException *exception);
207 
219 EXTERNAL long fiftyoneDegreesValueGetIndexByNameAndType(
220  const fiftyoneDegreesCollection *values,
221  const fiftyoneDegreesCollection *strings,
222  const fiftyoneDegreesProperty *property,
223  fiftyoneDegreesPropertyValueType storedValueType,
224  const char *valueName,
225  fiftyoneDegreesException *exception);
226 
237 EXTERNAL long fiftyoneDegreesValueGetIndexByName(
238  fiftyoneDegreesCollection *values,
239  fiftyoneDegreesCollection *strings,
240  fiftyoneDegreesProperty *property,
241  const char *valueName,
242  fiftyoneDegreesException *exception);
243 
248 #endif
fiftyoneDegreesValue::urlOffset
const int32_t urlOffset
The offset in the strings structure to the value URL.
Definition: value.h:78
fiftyoneDegreesValueGet
const fiftyoneDegreesValue * fiftyoneDegreesValueGet(const fiftyoneDegreesCollection *values, uint32_t valueIndex, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets the value for the requested index from the collection provided.
fiftyoneDegreesValueGetByName
const fiftyoneDegreesValue * fiftyoneDegreesValueGetByName(const fiftyoneDegreesCollection *values, const fiftyoneDegreesCollection *strings, const fiftyoneDegreesProperty *property, const char *valueName, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Get the value for the requested name from the collection 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:309
fiftyoneDegreesString
Definition: string.h:93
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
fiftyoneDegreesValueGetName
const fiftyoneDegreesString * fiftyoneDegreesValueGetName(const fiftyoneDegreesCollection *strings, const fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string name of the value using the item provided.
fiftyoneDegreesValueGetDescription
const fiftyoneDegreesString * fiftyoneDegreesValueGetDescription(const fiftyoneDegreesCollection *strings, const fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string description of the value using the item provided.
fiftyoneDegreesProperty
Property structure containing all the meta data relating to a property.
Definition: property.h:71
fiftyoneDegreesValueGetContent
const fiftyoneDegreesStoredBinaryValue * fiftyoneDegreesValueGetContent(const fiftyoneDegreesCollection *strings, const fiftyoneDegreesValue *value, fiftyoneDegreesPropertyValueType storedValueType, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the contents of the value using the item provided.
fiftyoneDegreesValue::propertyIndex
const int16_t propertyIndex
Index of the property the value relates to.
Definition: value.h:73
fiftyoneDegreesValueGetUrl
const fiftyoneDegreesString * fiftyoneDegreesValueGetUrl(const fiftyoneDegreesCollection *strings, const fiftyoneDegreesValue *value, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Returns the string URL of the value using the item provided.
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.
fiftyoneDegreesValueGetIndexByNameAndType
long fiftyoneDegreesValueGetIndexByNameAndType(const fiftyoneDegreesCollection *values, const fiftyoneDegreesCollection *strings, const fiftyoneDegreesProperty *property, fiftyoneDegreesPropertyValueType storedValueType, 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:402
fiftyoneDegreesStoredBinaryValue
"Packed" value that can be present inside "strings" of dataset.
Definition: storedBinaryValue.h:81
fiftyoneDegreesValueGetByNameAndType
const fiftyoneDegreesValue * fiftyoneDegreesValueGetByNameAndType(const fiftyoneDegreesCollection *values, const fiftyoneDegreesCollection *strings, const fiftyoneDegreesProperty *property, fiftyoneDegreesPropertyValueType storedValueType, const char *valueName, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Get the value for the requested name from the collection provided.

Generated by doxygen 1.8.15