\r\n

51Degrees Device Detection C/C++  4.4

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

Results

Detailed Description

Structure returned by an engine's process method(s), containing values.

Introduction

Results are the structure returned by an engine's process method(s) and contains the values for the properties in the engine. The base structure contains only the essential element of a data set, which is needed to return values. Any engine can extend this structure to add any additional elements which may be needed to format or return values.

The data set pointer is a managed resource, meaning that while the results exist, the data set will not be freed by the resource manager. This ensures that values contained in the data set used for processing can always be returned.

Collaboration diagram for Results:

Structs

struct  fiftyoneDegreesResultsBase
Base results structure which any processing results should extend. More...

Enumerations

enum  fiftyoneDegreesResultsNoValueReason {
  FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULT_FOR_PROPERTY,
  FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NULL_PROFILE, FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN
}
Enum containing reasons which cause a value to not be present or valid. More...

Functions

fiftyoneDegreesResultsBase *  fiftyoneDegreesResultsInit (fiftyoneDegreesResultsBase *results, void *dataSet)
Initialise a set of results by setting the data set they are associated with. More...

Enumeration Type Documentation

◆ fiftyoneDegreesResultsNoValueReason

enum fiftyoneDegreesResultsNoValueReason

Enum containing reasons which cause a value to not be present or valid.

Enumerator

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_DIFFERENCE 

The difference value is higher than the threshold, see the Pattern API.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_MATCHED_NODES 

No hash nodes were matched, see the Hash API.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_INVALID_PROPERTY 

The requested property does not exist, or is not a required property.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULT_FOR_PROPERTY 

There is no result which contains a value for the requested property.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NO_RESULTS 

There are no results to get a value from.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_TOO_MANY_VALUES 

There are too many values to be expressed as the requested type.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_NULL_PROFILE 

The results contain a null profile for the required component.

FIFTYONE_DEGREES_RESULTS_NO_VALUE_REASON_UNKNOWN 

None of the above.

Function Documentation

◆ fiftyoneDegreesResultsInit()

fiftyoneDegreesResultsBase* fiftyoneDegreesResultsInit ( fiftyoneDegreesResultsBase *   results,
void *   dataSet  
)

Initialise a set of results by setting the data set they are associated with.

Parameters
results - pointer to the results to initialise
dataSet - pointer to the data set which will be using the results
Returns
pointer to the initialised results
On This Page

Generated by doxygen 1.8.15