◆ fiftyoneDegreesComponentGetDefaultProfileId()
| uint32_t fiftyoneDegreesComponentGetDefaultProfileId | ( | fiftyoneDegreesCollection * | profiles, |
| fiftyoneDegreesComponent * | component, | ||
| fiftyoneDegreesException * | exception | ||
| ) |
Get the default profile id for the component provided.
- Parameters
-
- profiles - collection containing the profiles from the same data set as the component
- component - to get the default profile id for
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
◆ fiftyoneDegreesComponentGetFinalSize()
uint32_t fiftyoneDegreesComponentGetFinalSize ( const void * initial, fiftyoneDegreesException * exception ) Gets size of Component with trailing key-value pair.
- Parameters
-
- initial - pointer to component "head"
- Returns
- full (with tail) struct size
◆ fiftyoneDegreesComponentGetHeaders()
fiftyoneDegreesHeaderPtrs* fiftyoneDegreesComponentGetHeaders ( fiftyoneDegreesComponent * component, fiftyoneDegreesHeaders * headers, fiftyoneDegreesException * exception ) Where the component's key value pairs relate to headers creates an array of pointers to the relevant headers in the same order as the key value pairs.
- Parameters
-
- component - to get the headers for
- headers - array to find the corresponding header in
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
◆ fiftyoneDegreesComponentGetKeyValuePair()
const fiftyoneDegreesComponentKeyValuePair* fiftyoneDegreesComponentGetKeyValuePair ( fiftyoneDegreesComponent * component, uint16_t index, fiftyoneDegreesException * exception ) Get a pointer to the key value pair at the specified index within the component's key value pairs list.
This pointer does not need to be freed by the caller.
- Parameters
-
- component - to get the pair from
- index - of the pair within the component
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
- Returns
- pointer to a key value pair
◆ fiftyoneDegreesComponentGetName()
const fiftyoneDegreesString* fiftyoneDegreesComponentGetName ( fiftyoneDegreesCollection * stringsCollection, fiftyoneDegreesComponent * component, fiftyoneDegreesCollectionItem * item, fiftyoneDegreesException * exception ) Returns the string name of the component using the item provided.
The collection item must be released when the caller is finished with the string.
- Parameters
-
- component - structure for the name required.
- stringsCollection - collection of strings retrieved by offsets.
- 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.
◆ fiftyoneDegreesComponentInitList()
void fiftyoneDegreesComponentInitList ( fiftyoneDegreesCollection * components, fiftyoneDegreesList * list, uint32_t count, fiftyoneDegreesException * exception ) Initialises the list of components.
This holds a reference to the collection items so that collection get methods do not need to be called repeatedly.
- Parameters
-
- components - collection containing the components to add to the list
- list - to add the components to
- count - number of components in the collection
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
◆ fiftyoneDegreesComponentReadFromFile()
void* fiftyoneDegreesComponentReadFromFile ( const fiftyoneDegreesCollectionFile * file, const fiftyoneDegreesCollectionKey * key, fiftyoneDegreesData * data, fiftyoneDegreesException * exception ) Read a component from the file collection provided and store in the data pointer.
This method is used when creating a collection from file.
- Parameters
-
- file - collection to read from
- key - of the component in the collection
- data - to store the resulting component in
- exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h
- Returns
- pointer to the component allocated within the data structure