DicomObjects.NET Core Documentation
DicomObjects Namespace / DicomDataSet Class / Write Method / Write(String,String,Object,DicomDataSet,WriteBehaviours) Method

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.

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 entry.

The quality factor to be used.

The customized MetaHeader (only Group 2 Elements)

Specific options to use when writing the data




In This Topic
    Write(String,String,Object,DicomDataSet,WriteBehaviours) Method
    In This Topic
    Writes dataset to an external DICOM file with specified transfer syntax, quality factor, meta header and behaviour overrides
    Syntax
    'Declaration
     
    
    Public Overloads Sub Write( _
       ByVal FileName As String, _
       ByVal TransferSyntax As String, _
       ByVal Quality As Object, _
       ByVal MetaHeader As DicomDataSet, _
       ByVal Behaviour As WriteBehaviours _
    ) 
    'Usage
     
    
    Dim instance As DicomDataSet
    Dim FileName As String
    Dim TransferSyntax As String
    Dim Quality As Object
    Dim MetaHeader As DicomDataSet
    Dim Behaviour As WriteBehaviours
     
    instance.Write(FileName, TransferSyntax, Quality, MetaHeader, Behaviour)

    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.

    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 entry.

    Quality

    The quality factor to be used.

    MetaHeader

    The customized MetaHeader (only Group 2 Elements)

    Behaviour

    Specific options to use when writing the data

    Remarks

    The file may subsequently be read by the Read 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.

    The provided MetaHeader should only contain group 2 elements.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also