←Select platform

InsertFile Method

Summary
Adds a DICOM file to the Directory.
Syntax
C#
VB
C++
public void InsertFile( 
   string fileName 
) 
Public Sub InsertFile( _ 
   ByVal fileName As String _ 
)  
public: 
void InsertFile(  
   String^ fileName 
)  

Parameters

fileName
The name of the DICOM file to be added to the DICOM Directory.

Remarks

Before using this method to add a DICOM file to the Directory, a destination folder must have been specified, either at the construction time or by using the Reset method. Otherwise, the method will fail. The DICOM file to be added must reside in the destination folder or in a subfolder of the destination folder. Otherwise, the method will fail and the file will not be added to the directory. For example, if the destination folder is specified as "C:\DICOM Images\", then the DICOM file "C:\DICOM Images\Patient 1\Brain" can be added to the Directory, while the DICOM file "C:\Images\Knee" cannot be added. Please notice that the filename passed to the method must specify the absolute path of the file, not the relative one.

If fileName is set to a null reference (Nothing in VB), the method will add all the DICOM files contained in the destination folder to the DICOM Directory. In this case, the OnInsertFile callback method will be called for each file, so that the progress can be monitored. To add all the DICOM files in the destination folder and all the DICOM files in the subfolders of the destination folder, use the Options property to set IncludeSubfolders to true, and then call this method with fileName set to a null reference.

If fileName is not null, the OnInsertFile callback method will not be called.

Example

For an example, refer to Reset.

Requirements

Target Platforms

Help Version 22.0.2021.9.5
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly