RejectInvalidFileId Property

Gets or sets a value indicating whether the methods of the DicomDir class that take a filename as a parameter should fail if the number of components in the File ID exceeds 8 or if the number of characters in any component of the File ID exceeds 8.

Syntax

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

public bool RejectInvalidFileId {get; set;}

'Declaration

Public Property RejectInvalidFileId As Boolean

'Usage

Dim instance As DicomDirOptions
Dim value As Boolean
 
instance.RejectInvalidFileId = value
 
value = instance.RejectInvalidFileId

public bool RejectInvalidFileId {get; set;}

 <br/>get_RejectInvalidFileId();<br/>set_RejectInvalidFileId(value);<br/>Object.defineProperty('RejectInvalidFileId');

public:
property bool RejectInvalidFileId {
   bool get();
   void set (    bool value);
}

Property Value

true if the methods of the DicomDir class that take a filename as a parameter should fail if: - the number of components in the File ID exceeds 8 - the number of characters in any component of the File ID exceeds 8 (possible only for the last component, since the short format of filenames is used for File IDs); - any character other than those allowed by DICOM specification is used (valid characters include capitals A-Z, 0-9, and underscores). otherwise, false.

Remarks

As an example, if the destination folder is specified as "C:\DICOM Images\", then the following filenames will be rejected if RejectInvalidFileId is set to true:

"C:\DICOM Images\Sub1\Sub2\Sub3\Sub4\Sub5\Sub6\Sub7\Sub8\Brain"

"C:\DICOM Images\Patient 1\CT-10-Knee.dic"

The first filename is rejected because the number of components in the File ID exceeds 8 (there are 9 components, starting from "Sub1") and because lower case letters and spaces are used. The second filename is rejected because the number of characters in the last component, which is the short format of "CT-10-Knee.dic" (e.g., "CT-10-~1.dic") exceeds 8 and because lower case letters and spaces are used. On the other hand, the following filenames will not be rejected:

"C:\DICOM Images\SUB1\SUB2\SUB3\SUB4\SUB5\SUB6\SUB7\BRAIN"

"C:\DICOM Images\PATIENT1\KNEE"

Example

For an example, refer to Reset.

Requirements

Target Platforms

Reference

DicomDirOptions Structure
DicomDirOptions Members
InsertFile Method
InsertDataSet Method
SetDescriptorFile Method