◆ fiftyoneDegreesValueGet()
| fiftyoneDegreesValue* fiftyoneDegreesValueGet | ( | fiftyoneDegreesCollection * | values, |
| uint32_t | valueIndex, | ||
| fiftyoneDegreesCollectionItem * | item, | ||
| fiftyoneDegreesException * | exception | ||
| ) |
Gets the value for the requested index from the collection provided.
- Parameters
-
- values - collection to get the value from
- valueIndex - index of the value to get
- item - to store the value in
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.
- Returns
- pointer to the value or NULL
◆ 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.
- Parameters
-
- values - collection to get the value from
- strings - collection containing the value names
- property - that the value relates to
- valueName - name of the value to get
- item - to store the value in
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
- Returns
- pointer to the value or NULL if it does not exist
◆ fiftyoneDegreesValueGetDescription()
fiftyoneDegreesString* fiftyoneDegreesValueGetDescription ( fiftyoneDegreesCollection * strings, fiftyoneDegreesValue * value, fiftyoneDegreesCollectionItem * item, fiftyoneDegreesException * exception ) Returns the string description of the value using the item provided.
The collection item must be released when the caller is finished with the string.
- Parameters
-
- strings - collection of strings retrieved by offsets.
- value - structure for the description required.
- item - used to store the resulting string in.
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.
- Returns
- a pointer to a string in the collection item data structure.
◆ 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.
- Parameters
-
- values - collection to get the value from
- strings - collection containing the value names
- property - that the value relates to
- valueName - name of the value to get
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
- Returns
- the 0 based index of the item if found, otherwise -1
◆ fiftyoneDegreesValueGetName()
fiftyoneDegreesString* fiftyoneDegreesValueGetName ( fiftyoneDegreesCollection * strings, fiftyoneDegreesValue * value, fiftyoneDegreesCollectionItem * item, fiftyoneDegreesException * exception ) Returns the string name of the value using the item provided.
The collection item must be released when the caller is finished with the string.
- Parameters
-
- strings - collection of strings retrieved by offsets.
- value - structure for the name required.
- item - used to store the resulting string in.
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.
- Returns
- a pointer to a string in the collection item data structure.
◆ fiftyoneDegreesValueGetUrl()
fiftyoneDegreesString* fiftyoneDegreesValueGetUrl ( fiftyoneDegreesCollection * strings, fiftyoneDegreesValue * value, fiftyoneDegreesCollectionItem * item, fiftyoneDegreesException * exception ) Returns the string URL of the value using the item provided.
The collection item must be released when the caller is finished with the string.
- Parameters
-
- strings - collection of strings retrieved by offsets.
- value - structure for the URL required.
- item - used to store the resulting string in.
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.
- Returns
- a pointer to a string in the collection item data structure.