« Back to Product

Documentation

IPS_SetVariableCustomProfile

Require: IP-Symcon >= 3.0

 boolean IPS_SetVariableCustomProfile (int $VariableID, string $ProfileName) 

Parameters

VariableID

ID of the variable

ProfileName

Name of the profile. Available profiles can be queried via IPS_GetVariableProfileList. If an empty string is used, the custom profile is disabled.

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

This function sets the profile ProfileName as custom profile for the variable with the ID VariableID.

Warning

The function checks the existence as well of the compatibility of profile type and variable type before setting the custom profile.

Warning

Standard profiles can not be changed, if they are starting with a tilde (~).

Example

IPS_SetVariableCustomProfile(12345, "~Switch");
Any questions?