Sets the descriptor file (non-DICOM file) used for comments related to the file-set for which the Dicom Directory is created.
L_LTDIC_API L_UINT16 L_DicomDirSetDescriptorFile(hDicomDir, pszFileName, pszCharSet)
A DICOMDIR handle
Character string that contains the name of the file-set descriptor file.
Character string that contains 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.
|0||The function was successful.|
|> 0||An error occurred. Refer to Return Codes.|
This function 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
pszCharSet is set to NULL, the latter element will be deleted (if it exists). If the parameter
pszFileName is set to NULL, both elements will be deleted.
If the name of a descriptor file is to be specified, then before using this function, a destination folder must have been specified, either at construction time or later, using the function L_DicomDirReset. Otherwise, the function will fail.
The descriptor filename must refer to an existing file that resides in the destination folder or in a sub-folder of the destination folder. Otherwise, the function will fail. Notice that the filename passed to the function must specify the absolute path of the file, not the relative one.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries