Availability
This routine is available starting with SIL Engine™ 2.5.19 / 2.6.11.
Syntax
admCreateScreen(name, description)
Description
Creates a new screen.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Screen name. |
| description | string | yes | 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