←Select platform

FindStudyObjects Method

Summary

Queries for the DICOM studies information using matching parameters.

Syntax

C++

public Study[] FindStudyObjects( 
   string patientName, 
   string patientID, 
   string studyID, 
   string[] modalitiesInStudy, 
   string accessionNumber, 
   string referDrName, 
   string studyDateStart, 
   string studyDateEnd, 
   string studyTimeStart, 
   string studyTimeEnd, 
   string studyInstanceUID, 
   string sortField, 
   bool ascending, 
   int maxObjects, 
   string extraData 
)

  
Public Function FindStudyObjects( _ 
   ByVal patientName As String, _ 
   ByVal patientID As String, _ 
   ByVal studyID As String, _ 
   ByVal modalitiesInStudy() As String, _ 
   ByVal accessionNumber As String, _ 
   ByVal referDrName As String, _ 
   ByVal studyDateStart As String, _ 
   ByVal studyDateEnd As String, _ 
   ByVal studyTimeStart As String, _ 
   ByVal studyTimeEnd As String, _ 
   ByVal studyInstanceUID As String, _ 
   ByVal sortField As String, _ 
   ByVal ascending As Boolean, _ 
   ByVal maxObjects As Integer, _ 
   ByVal extraData As String _ 
) As Leadtools.Dicom.Services.Datatypes.Study()

public: 
Leadtools.Dicom.Services.Datatypes.array<Study^>^ FindStudyObjects(  
   String^ patientName, 
   String^ patientID, 
   String^ studyID, 
   array<String^>^ modalitiesInStudy, 
   String^ accessionNumber, 
   String^ referDrName, 
   String^ studyDateStart, 
   String^ studyDateEnd, 
   String^ studyTimeStart, 
   String^ studyTimeEnd, 
   String^ studyInstanceUID, 
   String^ sortField, 
   bool ascending, 
   int maxObjects, 
   String^ extraData 
)

Parameters

patientName
A System.String representing the patient name to match for. This parameter can be null.

patientID
A System.String representing the patient ID to match for. This parameter can be null.

studyID
A System.String representing the study ID to match for. This parameter can be null.

modalitiesInStudy
An array of strings that specify the modalities to match for. This parameter can be null.

accessionNumber
A System.String representing the accession number to match for. This parameter can be null.

referDrName
A System.String representing the Reference DR. Name to match for. This parameter can be null.

studyDateStart
A System.String representing the start date of the study to match. This parameter can be null.

studyDateEnd
A System.String representing the end date of the study to match. This parameter can be null.

studyTimeStart
A System.String representing the start time of the study to match. This parameter can be null.

studyTimeEnd
A System.String representing the end time of the study to math. This parameter can be null.

studyInstanceUID
A System.String representing the Study Instance UID of the study to match. This parameter can be null.

sortField
A System.String representing the field to perform sorting based on its values. This parameter can be null.

ascending
true to sort the returned results ascending, false to sort descending. This parameter can be null.

maxObjects
An System.Int32 value specifying the number of Leadtools.Dicom.Services.DataTypes.Study objects returned. Pass -1 to return all results.

extraData
user custom data.

Return Value

All Leadtools.Dicom.Services.DataTypes.Study objects found for the provided matching parameters.

Requirements

Target Platforms

Reference

DICOMService Class

DICOMService Members

Help Version 19.0.2017.10.27