SetSummary

Require: IP-Symcon >= 4.1

 boolean SetSummary (string $ShortInfo) 

Parameters

Returns

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

Description

This function sets the short information ShortInfo of the object, which is displayed in the administration console and can be read out again using IPS_GetObject.

Example

// puts a possible IP address in the short description to ensure quick recognition.
$this->SetSummary($this->ReadPropertyString("IPAddress"));