ObjectDCL Banner

LoadProject Method

Description

This method will load an ObjectDCL project.

Parameters

FilePath
String identifying the project file by name. It can be an absolute path. When a relative path or a simple project file name is passed, ObjectDCL will ask AutoCAD to search for the project file in its search paths.
Reload
Optional boolean when set to T triggers reloading the project.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the project file is not found, when attempting to reload an ODS file, when the file cannot be loaded properly, if a dialog is still showing or when the user does not have the licensed right to use ObjectDCL or the project specifically.

AutoLISP Syntax

CopyCode imageCopy Code
(Odcl_LoadProject 
		FilePath [as String]
		[Optional] Reload [as Boolean])

Remarks

An ODS file cannot be reloaded.

If you use the classic calling convention, consider that the value FilePath is what has to be passed on the ProjectFile parameter of methods.

Example

CopyCode imageCopy Code
; Load my project wherever it is if not done yet
(Odcl_LoadProject "MyProject.odc" Nil)

; Load my project where it is
(Odcl_LoadProject "C:\Program Files\MyApplication\MyProject.odc")

See Also

LoadProjectEx, UnloadProject