Detailed Description
A device detection specific data file initialised in a structure.
Introduction
Data set structure extending fiftyoneDegreesDataSetBase type with device detection specific elements. This adds the unique index of the User-Agent header and extends base methods to handle the specific data set type.
For further info see FiftyOneDegreesDataSet
Collaboration diagram for Device Detection Data Set:
Structs | |
| struct | fiftyoneDegreesDataSetDeviceDetection |
| Device detection data set structure which contains the 'must have's for all device detection data sets. More... | |
Function Documentation
◆ fiftyoneDegreesDataSetDeviceDetectionFree()
| void fiftyoneDegreesDataSetDeviceDetectionFree | ( | fiftyoneDegreesDataSetDeviceDetection * | dataSet | ) |
Closes the data set by freeing anything which has been initialised at creation.
This does not free the data set structure itself.
- Parameters
-
dataSet pointer to the data set to complete
◆ fiftyoneDegreesDataSetDeviceDetectionGet()
| fiftyoneDegreesDataSetDeviceDetection * fiftyoneDegreesDataSetDeviceDetectionGet | ( | fiftyoneDegreesResourceManager * | manager | ) |
Gets a pointer to the active data set from a resource manager.
Note that when this is finished with it must be released with the corresponding release method.
- Parameters
-
manager pointer to the manager which manages the data set resource
- Returns
- pointer to the data set resource
◆ fiftyoneDegreesDataSetDeviceDetectionInitPropertiesAndHeaders()
| fiftyoneDegreesStatusCode fiftyoneDegreesDataSetDeviceDetectionInitPropertiesAndHeaders | ( | fiftyoneDegreesDataSetDeviceDetection * | dataSet, |
| fiftyoneDegreesPropertiesRequired * | properties, | ||
| void * | state, | ||
| fiftyoneDegreesPropertiesGetMethod | getPropertyMethod, | ||
| fiftyoneDegreesHeadersGetMethod | getHeaderMethod, | ||
| fiftyoneDegreesOverridesFilterMethod | overridesFilter, | ||
| fiftyoneDegreesEvidencePropertiesGetMethod | getEvidencePropertiesMethod, | ||
| fiftyoneDegreesException * | exception ) |
Initialise the header and properties using the fiftyoneDegreesDataSetInitProperties and fiftyoneDegreesDataSetInitHeaders methods, set the index of the User-Agent header and initialise the override properties.
- Parameters
-
dataSet pointer to the pre allocated data set to be initialised properties the properties which should be initialised in the data set state pointer to data which is needed by get methods getPropertyMethod method used to retrieve the name of a property at a specified index from the data set getHeaderMethod method used to retrieve the unique id and name of a header at a specified index from the data set overridesFilter pointer to a filter method which determines whether or not a property is eligible to be overridden getEvidencePropertiesMethod method used to populate the list of evidence required for a property in the data set exception pointer to an exception data structure to be used if an exception occurs. See exceptions.h
- Returns
- the status associated with the header initialisation. Any value other than FIFTYONE_DEGREES_STATUS_SUCCESS means the headers were not initialised correctly
◆ fiftyoneDegreesDataSetDeviceDetectionRelease()
| void fiftyoneDegreesDataSetDeviceDetectionRelease | ( | fiftyoneDegreesDataSetDeviceDetection * | dataSet | ) |
Releases a reference to a data set which has been fetched via the DataSetGet method.
- Parameters
-
dataSet pointer to the data set to release
◆ fiftyoneDegreesDataSetDeviceDetectionReset()
| void fiftyoneDegreesDataSetDeviceDetectionReset | ( | fiftyoneDegreesDataSetDeviceDetection * | dataSet | ) |
Resets a newly allocated data set structure ready for initialisation.
- Parameters
-
dataSet pointer to the allocated data set