SetDescriptorFile Method

Summary

Sets the descriptor file (non-DICOM file) used for comments related to the file-set for which the DICOM Directory is created.

Syntax

C++

public void SetDescriptorFile( 
   string fileName, 
   string characterSet 
)

Public Sub SetDescriptorFile( _ 
   ByVal fileName As String, _ 
   ByVal characterSet As String _ 
)

public: 
void SetDescriptorFile(  
   String^ fileName, 
   String^ characterSet 
)

Parameters

fileName
The name of the file-set descriptor file.

characterSet
The name of the character set used in the descriptor file. For information on the possible character set names, refer to "Specific Character Set of File-set Descriptor File" (0004, 1142) element in the DICOM Standard.

Remarks

This method sets the values of the File-set Descriptor File ID (0004,1141) and the Specific Character Set of File-set Descriptor File (0004,1142) elements. If the parameter characterSet is set to a null reference (Nothing in VB), the latter element will be deleted (if it exists). If the parameter fileName is set to a null reference, both elements will be deleted. If the name of a descriptor file is to be specified, then before using this method, a destination folder must have been specified, either at construction time or later, using the method Reset. Otherwise, the method will fail.

The descriptor filename must refer to an existing file that resides in the destination folder or in a subfolder of the destination folder. Otherwise, the method will fail. Please notice that the filename passed to the method must specify the absolute path of the file, not the relative one.

Example

For an example, refer to Reset.

Requirements

Target Platforms