LEADTOOLS Medical (Leadtools.Dicom.Web assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.25
FindStudyObjects Method
See Also 
Leadtools.Dicom.Web Namespace > DicomWCFStreamer Class : FindStudyObjects Method



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 Study objects returned. pass -1 to return all results.
extraData
user custom data.
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 Study objects returned. pass -1 to return all results.
extraData
user custom data.
Queries for the DICOM studies information using matching parameters.

Syntax

Visual Basic (Declaration) 
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 Study()
Visual Basic (Usage)Copy Code
Dim instance As DicomWCFStreamer
Dim patientName As String
Dim patientID As String
Dim studyID As String
Dim modalitiesInStudy() As String
Dim accessionNumber As String
Dim referDrName As String
Dim studyDateStart As String
Dim studyDateEnd As String
Dim studyTimeStart As String
Dim studyTimeEnd As String
Dim studyInstanceUID As String
Dim sortField As String
Dim ascending As Boolean
Dim maxObjects As Integer
Dim extraData As String
Dim value() As Study
 
value = instance.FindStudyObjects(patientName, patientID, studyID, modalitiesInStudy, accessionNumber, referDrName, studyDateStart, studyDateEnd, studyTimeStart, studyTimeEnd, studyInstanceUID, sortField, ascending, maxObjects, 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 Study objects returned. pass -1 to return all results.
extraData
user custom data.

Return Value

Type: Array of Study All Study objects found for the provided matching parameters.

Requirements

Target Platforms: Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also