MSL: function mSetAdvOptions, change settings for displaying HTML banner in users' applications
Change settings for displaying HTML banner in users' applications. All changes applied instantly, no server or clients restart needed.
Syntax
function mSetAdvOptions(bEnable: boolean; sAdvLink: string; iAdvHeight, iAdvQuantity: integer): integer;
Parameters and return values
|
Parameter |
Type |
Value |
|
bEnable |
boolean |
banner current state: enabled/disabled; |
|
sAdvLink |
string |
file name or http(s) link for the banner; |
|
iAdvHeight |
integer |
banner size in vertical points; |
|
iAdvQuantity |
integer |
banner refresh frequency on the server (in minutes). |
Function result
|
0 |
all OK, settings saved; |
|
-1 |
you are using a free version of the server and can't change these settings; |
|
-2 |
banner heights must have a range from 0 to 400 points; |
|
-3 |
banner refresh frequency must be more than zero; |
|
-4 |
link to banner can't be empty; |
|
-5 |
specified html-file does not exist; |
|
-6 |
incorrect file name for the banner (name has forbidden characters); |
Example
begin
mSetAdvOptions(true, 'example.html', 60, 90);
end.