WriteFile Method

In This Topic

Description

Writes an image to an external DICOM file

Syntax

Visual Basic
Public Sub WriteFile( _ ByVal FileName As String, _ ByVal isPart10 As Boolean, _ Optional ByVal TransferSyntax As Variant, _ Optional ByVal Quality As Variant _ )

Visual Basic

Public Sub WriteFile( _
   ByVal FileName As String, _
   ByVal isPart10 As Boolean, _
   Optional ByVal TransferSyntax As Variant, _
   Optional ByVal Quality As Variant _
)

Parameters

FileName: The name of the file to write.
This is passed unmodified to the operating system, and it is therefore the container’s responsibility to ensure either that the current directory is set correctly, or that a fully qualified filename is provided.
isPart10: If TRUE, a blank 128 byte header, DICM marker, and meta-header are written at the start of the file, and an appropriate transfer syntax is used, as below.
If FALSE, the file is written in the unofficial, but common format, with no header, and using the little-endian implicit VR transfer syntax.
TransferSyntax: Specifies the full UID of the transfer syntax with which the file is to be saved when Part 10 format is used. If omitted, the little-endian explicit VR transfer syntax is used. For details of the currently supported syntaxes, see the conformance entry.
Quality: The quality factor to be used.

Remarks

The file may subsequently be read by the ReadFile method or by other DICOM software.
Quality is specific to the compression method being used, and is ignored for non-compressed or lossless JPEG transfer syntaxes. For Lossy JPEG, it is an integer in the range 1-100, the higher the number, the better the quality (and the larger the file), and for JPEG 2000 lossy, it is a compression ratio. Other compression methods may use this for other purposes in the future.
For writing the “DICOMDIR” directory file on exchangeable media, the WriteDirectory method should be used instead.

See the security page for details of restrictions on this method.