LEADTOOLS Medical (Leadtools.Dicom assembly)

OnInsertFile Method

Show in webframe







The name of the file being added to the DICOM Directory.
A DicomDataSet object that specifies the Data Set contained by the DICOM file being processed. If the Data Set wasn't loaded successfully, this parameter is set to a null reference (Nothing in Visual Basic).
The status code.
The error code. This parameter is always set to DicomExceptionCode.Success unless the parameter status is set to DicomDirInsertFileStatus.Failure.
Called for each DICOM file enumerated by the InsertFile method.
Syntax
'Declaration
 
Public Overridable Function OnInsertFile( _
   ByVal fileName As String, _
   ByVal dataSet As DicomDataSet, _
   ByVal status As DicomDirInsertFileStatus, _
   ByVal error As DicomExceptionCode _
) As DicomDirInsertFileCommand
'Usage
 
Dim instance As DicomDir
Dim fileName As String
Dim dataSet As DicomDataSet
Dim status As DicomDirInsertFileStatus
Dim error As DicomExceptionCode
Dim value As DicomDirInsertFileCommand
 
value = instance.OnInsertFile(fileName, dataSet, status, error)

            

            
 function Leadtools.Dicom.DicomDir.OnInsertFile( 
   fileName ,
   dataSet ,
   status ,
   error 
)

Parameters

fileName
The name of the file being added to the DICOM Directory.
dataSet
A DicomDataSet object that specifies the Data Set contained by the DICOM file being processed. If the Data Set wasn't loaded successfully, this parameter is set to a null reference (Nothing in Visual Basic).
status
The status code.
error
The error code. This parameter is always set to DicomExceptionCode.Success unless the parameter status is set to DicomDirInsertFileStatus.Failure.

Return Value

A value indicating how the enumeration of DICOM files should continue.
Remarks
If the parameter passed to InsertFile is a null reference (Nothing in Visual Basic), then all the files in the destination folder, and optionally all the files in the subfolders of the destination folder, will be enumerated. For each file, the callback method OnInsertFile is called once or twice:

If this method returned DicomDirInsertFileCommand.Stop, the method InsertFile will stop adding new files. Therefore, to keep adding the DICOM files, this method should return DicomDirInsertFileCommand.Continue, or DicomDirInsertFileCommand.Skip if only the current file is to be skipped (which can be done during the first call).

The method InsertFile will stop adding new files and will throw an exception if an error occurred.

The implementation of the DicomDir class for this method simply returns DicomDirInsertFileCommand.Continue. In order to make use of this callback method, you should create a new class derived from the DicomDir class and override the method providing the desired implementation.

Example
For an example, refer to Reset.
Requirements

Target Platforms

See Also

Reference

DicomDir Class
DicomDir Members
InsertFile Method

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features