Leadtools.Dicom Namespace > DicomDir Class : OnInsertFile Method |
public virtual DicomDirInsertFileCommand OnInsertFile( string fileName, DicomDataSet dataSet, DicomDirInsertFileStatus status, DicomExceptionCode error )
'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)
public virtual DicomDirInsertFileCommand OnInsertFile( string fileName, DicomDataSet dataSet, DicomDirInsertFileStatus status, DicomExceptionCode error )
public: virtual DicomDirInsertFileCommand OnInsertFile( String^ fileName, DicomDataSet^ dataSet, DicomDirInsertFileStatus status, DicomExceptionCode error )
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.