resolveSchema

[ Function ]

public resolveSchema(
    callback?: (data: Symbol.ISchemaResultObject) => void
): any;

Resolves the schema of the symbol and returns it using the callback function.

The callback function is called either synchronously or asynchronously, depending on the symbol type used.

Server

asynchron

Internal

synchron

LocalizedText

synchron

PartialParam

synchron

TemplateParam

synchron

Function

synchron

Control

synchron

Parameter

Name

Type

Description

callback [ optional ]

(data: Symbol.ISchemaResultObject) => void

This is triggered when the action has been successfully completed or an error has occurred. For details, please refer to the parameter data.

Return value

Type

Description

void

No return value

resolveSchema 1:

Available from version 1.10

Sample - JavaScript

var symbol = new TcHmi.Symbol('%s%PLC1.MAIN.sTest%/s%');
symbol.resolveSchema(function (data) {
    if (data.error === TcHmi.Errors.NONE) {
        // Handle result value... 
        var schema = data.schema; 
        console.log(schema); 
    } else {
        // Handle error... 
    }
});