Send Topic Feedback | See Object Hierarchy Chart
PC-DMIS 2023.2 Object Library
PCDLRN ActiveX DLL > AlignCmnd Object : ExternalFileID Property
ExternalFileID Property
Description

Represents the external filename for recalling external alignments.

  • For objects of type SAVE_ALIGN, it should include a ‘.aln’ extension and can include the fully qualified directory path. If it does not, indicates the alignment file should be written to the PC-DMIS default recall directory.
  • For objects of type RECALL_ALIGN set to recall an external alignment file, it should be only the filename, without a directory path or an extension.

Note: for releases prior to 2012, the required format is

<filename>:<ExternalID>

For example, if you create a SAVE_ALIGN object with ExternalFileID = “A2saved.aln” and ExternalID = “A2”, you would specify the RECALL_ALIGN object ExternalFileID as “A2saved:A2”.

This property should not be set if recalling an internal alignment.

Property type
Read-write property
Syntax
Visual Basic
Public Property ExternalFileID As String
Return Type
Read/write String.
Remarks

This function only works for objects of type RECALL_ALIGN and SAVE_ALIGN. If used on an object other than a RECALL_ALIGN or SAVE_ALIGN, setting this variable will do nothing, and getting this variable will return the empty string.

PC-DMIS version 2012 and newer can also accept values for ExternalFileID in the format for 2011 MR1 and prior releases. It will automatically convert those inputs to conform to the new format. For example, if you set ExternalFileID for a RECALL_ALIGN object to “A2saved:A2”, it will be converted to “A2saved” in the generated measurement routine.

See Also