[This is preliminary documentation and is subject to change.]
Validate Media Storage Files.
Declaration Syntax| C# | Visual Basic | Visual C++ |
bool ValidateMediaFiles( string[] mediaFileNames, string directoryRecordsToFilter, int numberDirectoryRecordsToFilter )
Function ValidateMediaFiles ( _ mediaFileNames As String(), _ directoryRecordsToFilter As String, _ numberDirectoryRecordsToFilter As Integer _ ) As Boolean
bool ValidateMediaFiles( array<String^>^ mediaFileNames, String^ directoryRecordsToFilter, int numberDirectoryRecordsToFilter )
Parameters- mediaFileNames (array< String >[]()[])
- List of media fully qualified file names to validate.
- directoryRecordsToFilter (String)
- Pipe delimited string indicating the Directory Records that should be filtered.
- numberDirectoryRecordsToFilter (Int32)
- Number of Directory Records to validate before filtering records of the same type out.
Return Value
falseFalsefalse if the validation process failed.
Remarks
Typically these files have the file-extension DCM. DVT does not check the file-extension.
The file should have an internal byte-prefix with byte-values 'DICOM'.
The directoryRecordsToFilter parameter can be any combination of the following Directory Record Types:
"ROOT"
"PATIENT"
"STUDY"
"SERIES"
"IMAGE"
"OVERLAY"
"MODALITY LUT"
"VOI LUT"
"CURVE"
"STORED PRINT"
"RT DOSE"
"RT STRUCTURE SET"
"RT PLAN"
"RT TREAT RECORD"
"PRESENTATION"
"WAVEFORM"
"SR DOCUMENT"
"KEY OBJECT DOC"
"TOPIC"
"VISIT""RESULTS"
"INTERPRETATION"
"STUDY COMPONENT"
"PRIVATE"
"PRINT QUEUE"
"FILM SESSION"
"FILM BOX"
"IMAGE BOX"
To include more than one record type - delimit the record types with the pipe "|" character
example: "IMAGE|PRIVATE|PRESENTATION" will filter on these 3 record types.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | Argument mediaFileNames is a nullNothingnullptr reference. |
| ArgumentException |
Argument mediaFileNames is an empty array of media file names.
|