Enumeration#
Functions
-
ITALA_API_C ItalaError NODE_EnumerationGetSymbolicsNum(H_NODE hNode, size_t *pNumOfSymbolics)#
Get the number of symbolic in the enumeratinon Node.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
pNumOfSymbolics – [out] Number of symbolic.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetSymbolicByIndex(H_NODE hNode, size_t index, char *symbolic, size_t *pSize)#
Get the symbolic in the enumeratinon Node, given a specif index.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
index – [in] Index of the symbolic.
symbolic – [out] Array of char, symbolic value.
pSize – [inout] Maximum element of the array in input, number of element filled in output.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetEntriesNum(H_NODE hNode, size_t *pNumOfEntries)#
Get the number of entries in the enumeratinon Node.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
pNumOfEntries – [out] Number of entires.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetEntryByIndex(H_NODE hNode, size_t index, H_NODE *phEnumEntry)#
Get the enem entry in the enumeratinon Node, given a specific index.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
index – [in] Index of the symbolic.
phEnumEntry – [out] Handle to enum entry Node instance.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationSetIntValue(H_NODE hNode, int64_t value)#
Set the value of the Node by integer.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
value – [in] Value to set.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetIntValue(H_NODE hNode, int64_t *pValue)#
Get the integer value of the enumeration Node.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
pValue – [out] Value retrived.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetEntryByName(H_NODE hNode, const char *name, H_NODE *phEnumEntry)#
Get the entry by name of the enumeration Node.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
name – [in] Name of the enum entry to retrive.
phEnumEntry – [out] Handle to enum entry Node instance.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetEntryByIntValue(H_NODE hNode, int64_t value, H_NODE *phEnumEntry)#
Get the enem entry in the enumeratinon Node, given the integer value of it.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
value – [in] Value of the enum entry to retrive.
phEnumEntry – [out] Handle to enum entry Node instance.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_EnumerationGetCurrentEntry(H_NODE hNode, H_NODE *phEnumEntry)#
Get the current enem entry in the enumeratinon Node.
- Parameters:
hNode – [in] Handle to Node instance, should be an Enumeration node.
phEnumEntry – [out] Handle to enum entry Node instance.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.