SetDescriptorFile method (ILEADDicomDir Interface)

VB.NET example

C# example

Visual Basic example

Visual C++ 6.0 example

 

Syntax

short SetDescriptorFile(BSTR bstrFileName, BSTR bstrCharSet);

Overview

Refer to Creating DICOM Directories.

Remarks

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

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 bstrCharSet is set to NULL, the latter element will be deleted (if it exists). If the parameter bstrFileName is set to NULL, 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 using the ResetDicomDir method. 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.

See Also

Elements:

ResetDicomDir method

Topics:

DICOM Elements: DICOM Directories