OpenProject

<< Click to Display Table of Contents >>

Navigation:  Reference (Scripting) > Docklight Script Commands - The DL Object > Methods >

OpenProject

Opens an existing Docklight project file (.ptp file).

 

Return Value

 

Void

 

Syntax

 

DL.OpenProject filePathName

 

The OpenProject method syntax has these parts:

 

Part

Description

filePathName

Required. String containing the file path (directory and file name) of the Docklight project file (.ptp file) to open. The file extension .ptp can be omitted. If no directory is specified, Docklight uses the current working directory.

 

Remarks

 

If filePathName is not a valid Docklight project file or does not exist, Docklight reports an error and the script execution is stopped.

 

If filePathName is an empty string, a file dialog will be displayed to choose a project file.

 

All Receive Sequence counters are reset when (re)opening a Docklight project, see the ResetReceiveCounter function.

 

 

Example

 

' Example OpenProject

 

' Load a Docklight project file

DL.OpenProject "D:\My Docklight Files\Test.ptp"

 

' Load the file 'Test.ptp' from the current working directory

DL.OpenProject "Test"