« Back to Product

Documentation

IPS_SetVariableCustomProfile

Require: Symcon >= 3.0

 bool 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 function succeeds, it returns TRUE, otherwise FALSE.

Description

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

Warning

Before setting the custom profile, the function checks whether the profile exists and whether the profile type matches the variable type.

Warning

Standard profiles, which cannot be changed, start with a tilde (~).

Example

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