LEADTOOLS Medical (Leadtools.Dicom assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
SetDescriptorFile Method
See Also 
Leadtools.Dicom Namespace > DicomDir Class : SetDescriptorFile Method



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.
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.
Sets the descriptor file (non-DICOM file) used for comments related to the file-set for which the DICOM Directory is created.

Syntax

Visual Basic (Declaration) 
Public Sub SetDescriptorFile( _
   ByVal fileName As String, _
   ByVal characterSet As String _
) 
Visual Basic (Usage)Copy Code
Dim instance As DicomDir
Dim fileName As String
Dim characterSet As String
 
instance.SetDescriptorFile(fileName, characterSet)
C# 
public void SetDescriptorFile( 
   string fileName,
   string characterSet
)
C++/CLI 
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.

Example

For an example, refer to DicomDir.Reset.

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 Visual Basic), 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 DicomDir.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.

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features