Skip to end of banner
Go to start of banner

admCreateScreen

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Availability

This routine is available since katl-commons 2.5.19 / 2.6.11.

Syntax:

admCreateScreen(name, description)

Description:

Creates a new screen.

Parameters:

Parameter name

Type

Required

Description

namestringyesThe screen name
descriptionstringyesThe screen description (can be blank)

Return type:

string

Returns the id (as a number) of the newly created screen.

Example:

Example 1:

Creating a screen:

admCreateScreen("Test Screen", "Test screen description");

Example 2:

Creating a screen with empty description:

admCreateScreen("Test Screen", "");

The method throws an exception if the name parameter is empty or a screen with the same name already exists.


See Also:

  • No labels