« Back to Product

Documentation

Management of Variables

.

IPS_CreateVariable

creates a new variable

IPS_DeleteVariable

deletes a variable

IPS_GetVariable

retuns extensive information about a variable

IPS_GetVariableEventList

returns a list of all events that are associated to a variable

IPS_GetVariableIDByName

returns the ID of a variable by its name

IPS_GetVariableList

returns a list of all existing variables

IPS_SetVariableCustomAction

set a user defined action script for a variable

IPS_SetVariableCustomProfile

sets a user defined profile for a variable

IPS_VariableExists

checks if a variable exists

Variable Presentation

Functions in this group are used to manage variable presentations

IPS_GetPresentationprovides comprehensive information about a specific representation
IPS_GetPresentationFormreturns the configuration form of a representation for a variable type
IPS_GetPresentationsprovides all presentations of the system
IPS_PresentationExistsChecks whether a specific presentation exists
Management of TemplatesFunctions in this group are used to manage templates
IPS_CreateTemplatecreates a new template for a specific display
IPS_DeleteTemplateDeletes a template
IPS_GetTemplateprovides comprehensive information about a template
IPS_GetTemplateListprovides all available templates
IPS_GetTemplateListByPresentationprovides a list of the templates of a representation
IPS_SetTemplateNamesets the name of a template
IPS_SetTemplateValuessets the values of a template
IPS_TemplateExistsChecks whether a template exists

Variable Profiles

IPS_CreateVariableProfilecreates a variable profile
IPS_DeleteVariableProfiledeletes a variable profile
IPS_GetVariableProfilereturns extensive information about a variable profile
IPS_GetVariableProfileListreturns a list of all existing variable profiles
IPS_GetVariableProfileListByTypereturns a list of all existing variable profiles of a specific type
IPS_SetVariableProfileAssociationmodifies the association table of a variable profile
IPS_SetVariableProfileDigitssets the digits of a variable profile
IPS_SetVariableProfileIconsets the icon for a variable profile
IPS_SetVariableProfileTextsets prefix and suffix for a variable profile
IPS_SetVariableProfileValuessets the minimal value, maximal value, and stepsize of a variable profile
IPS_VariableProfileExistschecks if a variable profile exists
Any questions?