Leadtools.Dicom Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.10.31
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.
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
)
Managed Extensions for 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 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 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: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

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