ObjectDCL Banner

BlockList_GetFileName Method

Description

This method will return the file name of the external loaded Dwg file.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.

Return Values

Returns the following according to the situation:

  • String specifying the file name.
  • Nil if the control is not found, does not support this function or no Dwg file is loaded.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_BlockList_GetFileName 
		MyControlReference [as Reference])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_BlockList_GetFileName
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

BlockList.

Example

CopyCode imageCopy Code
; Get the file name
(setq rValue (Odcl_BlockList_GetFileName MyProject_MyForm_MyControl))

See Also

BlockList_LoadDwg, BlockList_Reset