SetWebStartUrl Method (RUNTIME)

PLB Web Only, 10.9

The SetWebStartUrl method changes the URL loaded into a WINDOW or HTMLCONTROL when WebView support is required. This allows a custom start page to be used. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A RUNTIME object.

return

Optional. A Numeric Variable that receives the error result for the execution of the method.

url

Required. A Character String Variable or string literal that defines the URL (Uniform Resource Locator) to be loaded.

options

Optional. A Numeric variable or decimal number that invokes special behaviors for the method.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The EOS and OVER flags are always cleared.

2. The ZERO flag is always set to TRUE with a return value of zero.

3. The optional {options} values changes the execution behavior of the SetWebStartUrl method as follows:

 

 

Value	Description
0	The URL is given is a fully qualified URL.
1	The URL is given as a file name of a file located in the plbwv_html directory.

 

4. The {return} value is zero if the SetWebStartUrl method executes successfully.

5. The error values returned in {return} are defined as follows:

 

Error	Description
1	Local URL not supported.
2	File not found.

 

6. Setting the URL to a NULL string causes the default start URL to be used.

See Also: RUNTIME, Method Syntax