'Declaration
 
Public Overloads Function Read( _
   ByVal FileName As System.String, _
   Optional ByVal ReadBehaviour As ReadBehaviours _
) As DicomImage

'Usage
 
Dim instance As DicomImageCollection
Dim FileName As System.String
Dim ReadBehaviour As ReadBehaviours
Dim value As DicomImage
 
value = instance.Read(FileName, ReadBehaviour)

public DicomImage Read( 
   System.string FileName,
   ReadBehaviours ReadBehaviour
)

public function Read( 
    FileName: System.String;
    ReadBehaviour: ReadBehaviours
): DicomImage; 

public function Read( 
   FileName : System.String,
   ReadBehaviour : ReadBehaviours
) : DicomImage;

public: DicomImage* Read( 
   System.string* FileName,
   ReadBehaviours* ReadBehaviour
) 

public:
DicomImage^ Read( 
   System.String^ FileName,
   ReadBehaviours^ ReadBehaviour
) 

Parameters

FileName

The name of the file to read.

This is passed unmodified to the operating system, and it is therefore the container’s responsibility to ensure either that the file exists within the current directory, or that a fully qualified filename is provided.

ReadBehaviour

The behaviours to be used when reading this stream

Return Value

This method can read either official "Part10" format files with the 128 byte header, or unofficial "Part5" format files without a header. Detection of the type is automatic.

The file may have been written by the Write method or by other DICOM software.

By default, pixel data is read only when it is required, greatly speeding the display of multi-frame images, and reducing memory requirements. However, a side effect of this is that any elements after the pixel data (7FE0,0010) will not be read. This should not affect most applications, but if necessary, this behavior may be over-ridden using the CloseFilesAfterReading property.

Another effect of file mapping is that files read using this method cannot be deleted until the image object is released. This method creates two references to the newly created DicomImage object (one in the collection, and one as the return value), and both must be released before the file can be deleted.

Target Platforms: .NET CLR 4.8 or higher