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

Hash/StronglyTyped.c

Strongly Typed example of using 51Degrees device detection.

Strongly Typed example of using 51Degrees device detection.The example shows how to:

  1. Specify the name of the data file and properties the data set should be initialised with.
    const char* fileName = argv[1];
    fiftyoneDegreesPropertiesRequired properties =
    fiftyoneDegreesPropertiesDefault;
    properties.string = "IsMobile";
    fiftyoneDegreesPropertiesRequired
    Defines a set of properties which are required by a caller.
    Definition properties.h:229
    fiftyoneDegreesPropertiesRequired::string
    const char * string
    Separated list of required properties or NULL if all properties are required.
    Definition properties.h:234
  2. Instantiate the 51Degrees data set within a resource manager from the specified data file with the required properties and the specified configuration.
    fiftyoneDegreesStatusCode status =
    fiftyoneDegreesHashInitManagerFromFile(
    &manager,
    &config,
    &properties,
    dataFilePath,
    exception);
    fiftyoneDegreesHashInitManagerFromFile
    fiftyoneDegreesStatusCode fiftyoneDegreesHashInitManagerFromFile(fiftyoneDegreesResourceManager *manager, fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, const char *fileName, fiftyoneDegreesException *exception)
    Initialises the resource manager with a Hash data set resource populated from the Hash data file refe...
    fiftyoneDegreesStatusCode
    fiftyoneDegreesStatusCode
    Status returned from the initialisation of a resource.
    Definition status.h:81
  3. Create a results instance ready to be populated by the data set.
    fiftyoneDegreesResultsHash *results =
    fiftyoneDegreesResultsHashCreate(
    &manager,
    1,
    0);
    fiftyoneDegreesResultsHash
    fiftyoneDegreesResultHashArray fiftyoneDegreesResultsHash
    Array of Hash results used to easily access and track the size of the array.
    Definition hash.h:364
    fiftyoneDegreesResultsHashCreate
    fiftyoneDegreesResultsHash * fiftyoneDegreesResultsHashCreate(fiftyoneDegreesResourceManager *manager, uint32_t userAgentCapacity, uint32_t overridesCapacity)
    Allocates a results structure containing a reference to the Hash data set managed by the resource man...
  4. Process a single HTTP User-Agent string to retrieve the values associated with the User-Agent for the selected properties.
    fiftyoneDegreesResultsHashFromUserAgent(
    results,
    mobileUserAgent,
    strlen(mobileUserAgent),
    exception);
    fiftyoneDegreesResultsHashFromUserAgent
    void fiftyoneDegreesResultsHashFromUserAgent(fiftyoneDegreesResultsHash *results, const char *userAgent, size_t userAgentLength, fiftyoneDegreesException *exception)
    Process a single User-Agent and populate the device offsets in the results structure.
  5. Check the type of values the property returns.
    fiftyoneDegreesProperty *property = fiftyoneDegreesPropertyGetByName(
    dataSet->properties,
    dataSet->strings,
    propertyName,
    &item,
    exception);
    fiftyoneDegreesPropertyValueType type = property->valueType;
    fiftyoneDegreesProperty
    Property structure containing all the meta data relating to a property.
    Definition property.h:75
  1. Extract the value of a property as a boolean from the results.
    requiredPropertyIndex =
    fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName(
    dataSet->available,
    propertyName);
    if (requiredPropertyIndex >= 0) {
    valueName = FIFTYONE_DEGREES_STRING(
    fiftyoneDegreesResultsHashGetValues(
    results,
    requiredPropertyIndex,
    exception));
    bool value = strcmp(valueName, "True") == 0;
    fiftyoneDegreesResultsHashGetValues
    fiftyoneDegreesCollectionItem * fiftyoneDegreesResultsHashGetValues(fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception)
    Populates the list of values in the results instance with value structure instances associated with t...
    FIFTYONE_DEGREES_STRING
    #define FIFTYONE_DEGREES_STRING(s)
    Macro used to check for NULL before returning the string as a const char *.
    Definition string.h:84
  2. Release the memory used by the results.
    fiftyoneDegreesResultsHashFree(results);
    fiftyoneDegreesResultsHashFree
    void fiftyoneDegreesResultsHashFree(fiftyoneDegreesResultsHash *results)
    Frees the results structure created by the fiftyoneDegreesResultsHashCreate method.
  3. Finally release the memory used by the data set resource.
    fiftyoneDegreesResourceManagerFree(&manager);

This example differs from the Getting Started example by using boolean values for the isMobile property instead of string values.

/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
* Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
*
* This Original Work is licensed under the European Union Public Licence
* (EUPL) v.1.2 and is subject to its terms as set out below.
*
* If a copy of the EUPL was not distributed with this file, You can obtain
* one at https://opensource.org/licenses/EUPL-1.2.
*
* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
* amended by the European Commission) shall be deemed incompatible for
* the purposes of the Work and the provisions of the compatibility
* clause in Article 5 of the EUPL shall not apply.
*
* If using the Work as, or as part of, a network application, by
* including the attribution notice(s) required under Article 5 of the EUPL
* in the end user terms of the application under an appropriate heading,
* such notice(s) shall fulfill the requirements of that article.
* ********************************************************************* */
#include <stdio.h>
// Include ExmapleBase.h before others as it includes Windows 'crtdbg.h'
// which requires to be included before 'malloc.h'.
#include "ExampleBase.h"
#include "../../../../src/dd/hash/hash.h"
#include "../../../../src/dd/hash/fiftyone.h"
static const char *dataDir = "data/device-detection";
static const char *dataFileName = "51Degrees-LiteV4.1.hash";
// Returned by main. Set to 1 when the data file cannot be used.
static int exitCode = 0;
static bool getPropertyIsBool(
ResultsHash *results,
const char *propertyName) {
EXCEPTION_CREATE;
Item item;
DataReset(&item.data);
DataSetHash *dataSet = (DataSetHash*)results->b.b.dataSet;
const Property *property = PropertyGetByName(
dataSet->properties,
dataSet->strings,
propertyName,
&item,
exception);
EXCEPTION_THROW;
bool isBool = property->valueType == FIFTYONE_DEGREES_PROPERTY_VALUE_TYPE_BOOLEAN;
EXAMPLE_COLLECTION_RELEASE(dataSet->properties, item);
return isBool;
}
static bool getPropertyValueAsBool(
ResultsHash *results,
const char *propertyName) {
EXCEPTION_CREATE;
bool value = false;
int requiredPropertyIndex;
const char *valueName;
DataSetBase *dataSet = (DataSetBase*)results->b.b.dataSet;
if (getPropertyIsBool(results, propertyName) == true) {
requiredPropertyIndex =
PropertiesGetRequiredPropertyIndexFromName(
dataSet->available,
propertyName);
if (requiredPropertyIndex >= 0) {
if (ResultsHashGetValues(
results,
requiredPropertyIndex,
exception) != NULL && EXCEPTION_OKAY) {
valueName = STRING(results->values.items[0].data.ptr);
if (strcmp(valueName, "True") == 0) {
value = true;
}
}
}
}
return value;
}
static void printBoolValues(ResultsHash *results) {
uint32_t i;
const char *propertyName;
DataSetBase *dataSet = (DataSetBase*)results->b.b.dataSet;
for (i = 0; i < dataSet->available->count; i++) {
propertyName = STRING(
dataSet->available->items[i].name.data.ptr);
printf(" %s: %d\n",
propertyName,
getPropertyValueAsBool(results, propertyName));
}
}
static void reportStatus(StatusCode status,
const char* fileName) {
const char *message = StatusGetMessage(status, fileName);
printf("%s\n", message);
Free((void*)message);
}
void fiftyoneDegreesHashStronglyTyped(
const char *dataFilePath,
ConfigHash *config) {
EXCEPTION_CREATE;
ResourceManager manager;
// Set the properties to be returned for each User-Agent.
PropertiesRequired properties = PropertiesDefault;
properties.string = "ScreenPixelsWidth,HardwareModel,IsMobile,BrowserName";
// Initialise the manager for device detection.
StatusCode status = HashInitManagerFromFile(
&manager,
config,
&properties,
dataFilePath,
exception);
if (status != SUCCESS) {
reportStatus(status, dataFilePath);
exitCode = 1;
fgetc(stdin);
return;
}
// Create a results instance to store and process User-Agents.
ResultsHash *results = ResultsHashCreate(&manager, 0);
// User-Agent string of an iPhone mobile device.
const char* mobileUserAgent = (
"Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) "
"AppleWebKit/537.51.2 (KHTML, like Gecko) Version/7.0 Mobile/11D167 "
"Safari/9537.53");
// User-Agent string of Firefox Web browser version 41 on desktop.
const char* desktopUserAgent = (
"Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) "
"Gecko/20100101 Firefox/41.0");
// User-Agent string of a MediaHub device.
const char* mediaHubUserAgent = (
"Mozilla/5.0 (Linux; Android 4.4.2; X7 Quad Core "
"Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 "
"Chrome/30.0.0.0 Safari/537.36");
printf("Starting Getting Started Example.\n");
// Carries out a match for a mobile User-Agent.
printf("\nMobile User-Agent: %s\n", mobileUserAgent);
ResultsHashFromUserAgent(
results,
mobileUserAgent,
strlen(mobileUserAgent),
exception);
EXCEPTION_THROW;
printBoolValues(results);
// Carries out a match for a desktop User-Agent.
printf("\nDesktop User-Agent: %s\n", desktopUserAgent);
ResultsHashFromUserAgent(
results,
desktopUserAgent,
strlen(desktopUserAgent),
exception);
EXCEPTION_THROW;
printBoolValues(results);
// Carries out a match for a MediaHub User-Agent.
printf("\nMedia hub User-Agent: %s\n", mediaHubUserAgent);
ResultsHashFromUserAgent(
results,
mediaHubUserAgent,
strlen(mediaHubUserAgent),
exception);
EXCEPTION_THROW;
printBoolValues(results);
// Ensure the results are freed to avoid memory leaks.
ResultsHashFree(results);
// Free the resources used by the manager.
ResourceManagerFree(&manager);
}
void fiftyoneDegreesExampleCStronglyTypedRun(ExampleParameters *params) {
// Call the actual function.
fiftyoneDegreesHashStronglyTyped(
params->dataFilePath,
params->config);
}
#ifndef TEST
int main(int argc, char* argv[]) {
StatusCode status = SUCCESS;
ConfigHash config = HashDefaultConfig;
char dataFilePath[FILE_MAX_PATH];
if (argc > 1) {
strcpy(dataFilePath, argv[1]);
}
else {
status = fiftyoneDegreesExampleGetFilePath(
dataDir,
dataFileName,
dataFilePath,
sizeof(dataFilePath));
}
if (status != SUCCESS) {
reportStatus(status, dataFileName);
fgetc(stdin);
return 1;
}
if (CollectionGetIsMemoryOnly()) {
config = HashInMemoryConfig;
}
ExampleParameters params;
params.dataFilePath = dataFilePath;
params.config = &config;
// Run the example
fiftyoneDegreesExampleMemCheck(
&params,
fiftyoneDegreesExampleCStronglyTypedRun);
// Wait for a character to be pressed.
fgetc(stdin);
return exitCode;
}
#endif
ResultsHashGetValues
#define ResultsHashGetValues
Synonym for fiftyoneDegreesResultsHashGetValues function.
Definition dd/hash/fiftyone.h:58
ConfigHash
fiftyoneDegreesConfigHash ConfigHash
Synonym for fiftyoneDegreesConfigHash type.
Definition dd/hash/fiftyone.h:51
ResultsHash
fiftyoneDegreesResultsHash ResultsHash
Synonym for fiftyoneDegreesResultsHash type.
Definition dd/hash/fiftyone.h:50
HashInMemoryConfig
#define HashInMemoryConfig
Synonym for fiftyoneDegreesHashInMemoryConfig config.
Definition dd/hash/fiftyone.h:86
DataSetHash
fiftyoneDegreesDataSetHash DataSetHash
Synonym for fiftyoneDegreesDataSetHash type.
Definition dd/hash/fiftyone.h:48
ResultsHashFromUserAgent
#define ResultsHashFromUserAgent
Synonym for fiftyoneDegreesResultsHashFromUserAgent function.
Definition dd/hash/fiftyone.h:69
ResultsHashCreate
#define ResultsHashCreate(manager, overridesCapacity)
Two argument convenience form of fiftyoneDegreesResultsHashCreate that injects the deprecated userAge...
Definition dd/hash/fiftyone.h:66
HashDefaultConfig
#define HashDefaultConfig
Synonym for fiftyoneDegreesHashDefaultConfig config.
Definition dd/hash/fiftyone.h:91
ResultsHashFree
#define ResultsHashFree
Synonym for fiftyoneDegreesResultsHashFree function.
Definition dd/hash/fiftyone.h:67
HashInitManagerFromFile
#define HashInitManagerFromFile
Synonym for fiftyoneDegreesHashInitManagerFromFile function.
Definition dd/hash/fiftyone.h:75
STRING
#define STRING
Synonym for FIFTYONE_DEGREES_STRING macro.
Definition common/fiftyone.h:448
EXCEPTION_THROW
#define EXCEPTION_THROW
Synonym for FIFTYONE_DEGREES_EXCEPTION_THROW macro.
Definition common/fiftyone.h:446
CollectionGetIsMemoryOnly
#define CollectionGetIsMemoryOnly
Synonym for fiftyoneDegreesCollectionGetIsMemoryOnly function.
Definition common/fiftyone.h:342
PropertiesDefault
#define PropertiesDefault
Synonym for fiftyoneDegreesPropertiesDefault function.
Definition common/fiftyone.h:268
EXCEPTION_CREATE
#define EXCEPTION_CREATE
Synonym for FIFTYONE_DEGREES_EXCEPTION_CREATE macro.
Definition common/fiftyone.h:443
StatusGetMessage
#define StatusGetMessage
Synonym for fiftyoneDegreesStatusGetMessage function.
Definition common/fiftyone.h:293
PropertiesGetRequiredPropertyIndexFromName
#define PropertiesGetRequiredPropertyIndexFromName
Synonym for fiftyoneDegreesPropertiesGetRequiredPropertyIndexFromName function.
Definition common/fiftyone.h:325
PropertyGetByName
#define PropertyGetByName
Synonym for fiftyoneDegreesPropertyGetByName function.
Definition common/fiftyone.h:383
Item
fiftyoneDegreesCollectionItem Item
Synonym for fiftyoneDegreesCollectionItem type.
Definition common/fiftyone.h:105
StatusCode
fiftyoneDegreesStatusCode StatusCode
Synonym for fiftyoneDegreesStatusCode type.
Definition common/fiftyone.h:134
DataSetBase
fiftyoneDegreesDataSetBase DataSetBase
Synonym for fiftyoneDegreesDataSetBase type.
Definition common/fiftyone.h:136
EXCEPTION_OKAY
#define EXCEPTION_OKAY
Synonym for FIFTYONE_DEGREES_EXCEPTION_OKAY macro.
Definition common/fiftyone.h:444
SUCCESS
#define SUCCESS
Synonym for FIFTYONE_DEGREES_STATUS_SUCCESS status code.
Definition common/fiftyone.h:478
DataReset
#define DataReset
Synonym for fiftyoneDegreesDataReset function.
Definition common/fiftyone.h:250
Property
fiftyoneDegreesProperty Property
Synonym for fiftyoneDegreesProperty type.
Definition common/fiftyone.h:161
ResourceManagerFree
#define ResourceManagerFree
Synonym for fiftyoneDegreesResourceManagerFree function.
Definition common/fiftyone.h:310
ResourceManager
fiftyoneDegreesResourceManager ResourceManager
Synonym for fiftyoneDegreesResourceManager type.
Definition common/fiftyone.h:137
PropertiesRequired
fiftyoneDegreesPropertiesRequired PropertiesRequired
Synonym for fiftyoneDegreesPropertiesRequired type.
Definition common/fiftyone.h:135
Free
#define Free
Synonym for fiftyoneDegreesFree function.
Definition common/fiftyone.h:265
FILE_MAX_PATH
#define FILE_MAX_PATH
Synonym for FIFTYONE_DEGREES_FILE_MAX_PATH macro.
Definition common/fiftyone.h:450
fiftyoneDegreesCollectionItem::data
fiftyoneDegreesData data
Item data including allocated memory.
Definition collection.h:316
fiftyoneDegreesDataSetHash::strings
fiftyoneDegreesCollection * strings
Collection of all strings.
Definition hash.h:274
fiftyoneDegreesDataSetHash::properties
fiftyoneDegreesCollection * properties
Collection of all properties.
Definition hash.h:286
fiftyoneDegreesResultHashArray::items
fiftyoneDegreesResultHash * items
Pointer to the first item.
Definition hash.h:352

Have a data or code question? Get in touch and explore subscription options.