« Back to Product

Documentation

Send feedback!

IPS_GetTemplate

Require: IP-Symcon >= 8.0

 array IPS_GetTemplate (string $TemplateID)

Parameters

TemplateID

The ID of the template, formatted as GUID

Returns

The following information is available as key=>value pairs:

Index Type Description
TemplateID string The ID of the template
PresentationID string The ID of the presentation to which this template belongs
DisplayName string The display name of the template
Values array An array with the values of the template
ReadOnly bool Whether the template can be changed

Description

The function returns an array with information about the template with the ID TemplateID.

Example

// Returns information about the room temperature template
print_r(IPS_GetTemplate('{868B087E-A38D-2155-EBE0-157AFBBF9E8C}' /* Raumptemperatur */);
/* Beispielausgabe:
Array
(
    [TemplateID] => {868B087E-A38D-2155-EBE0-157AFBBF9E8C}
    [PresentationID] => {6B9CAEEC-5958-C223-30F7-BD36569FC57A}
    [DisplayName] => Room Temperature
    [Values] => Array
        (
            [MIN] => 15
            [DIGITS] => 1
            [CUSTOM_GRADIENT] => []
            [DECIMAL_SEPARATOR] => Client
            [GRADIENT_TYPE] => 1
            [MAX] => 25
            [INTERVALS] => []
            [INTERVALS_ACTIVE] => 
            [PERCENTAGE] => 
            [PREFIX] => 
            [STEP_SIZE] => 0.5
            [SUFFIX] =>  °C
            [THOUSANDS_SEPARATOR] => 
            [USAGE_TYPE] => 0
        )

    [IsReadOnly] => 1
)
*/
Any questions?