Leadtools.Medical.Workstation.Client Requires Medical product license | Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
RetrieveImages Method
See Also  Example
Leadtools.Medical.Workstation.Client Namespace > RetrieveClient Class : RetrieveImages Method



studyInstanceUID
The Study Instance UID String value to match against the retrieved datasets. This can be null or Empty.
seriesInstanceUID
The Series Instance UID String value to match against the retrieved datasets. This can be null or Empty.
studyInstanceUID
The Study Instance UID String value to match against the retrieved datasets. This can be null or Empty.
seriesInstanceUID
The Series Instance UID String value to match against the retrieved datasets. This can be null or Empty.
Starts the operation of retrieving DICOM DataSets.

Syntax

Visual Basic (Declaration) 
Public Function RetrieveImages( _
   ByVal studyInstanceUID As String, _
   ByVal seriesInstanceUID As String _
) As IEnumerable(Of KeyValuePair(Of String, RetrievedDataSet))
Visual Basic (Usage)Copy Code
Dim instance As RetrieveClient
Dim studyInstanceUID As String
Dim seriesInstanceUID As String
Dim value As IEnumerable(Of KeyValuePair(Of String, RetrievedDataSet))
 
value = instance.RetrieveImages(studyInstanceUID, seriesInstanceUID)
C++/CLI 
public:
IEnumerable<KeyValuePair<String, RetrievedDataSet>>^ RetrieveImages( 
   String^ studyInstanceUID,
   String^ seriesInstanceUID
) 

Parameters

studyInstanceUID
The Study Instance UID String value to match against the retrieved datasets. This can be null or Empty.
seriesInstanceUID
The Series Instance UID String value to match against the retrieved datasets. This can be null or Empty.

Return Value

An IEnumerable of a KeyValuePair Enumerator which holds the DICOM instance SOP Instance UID as its key and a RetrievedDataSet as its value.

Example

Visual BasicCopy Code
<Test> _
Public Sub RetrieveLocalDatabase()
  Leadtools.Examples.Support.Unlock()
  Dim clientInfo As AeInfo = New AeInfo ()


  clientInfo.Address = Dns.GetHostName() 'local machine
  clientInfo.AETitle = "TEST_CLIENT"
  clientInfo.Port = 1000

  'Make sure that the MoveAddIn is configured properly before using this class.
  Dim client As DbRetrieveClient = New DbRetrieveClient (clientInfo)

  client.LoadRetrievedDataSet = False 'Enable this if you need to read information from the DICOM dataset.

  client.EnableLog = True
  client.LogFileName = ("c:\DicomLog.txt")

  PerformClientRetrieve(client)
End Sub

     Public Sub PerformClientRetrieve(ByVal client As RetrieveClient)


         Dim images As IEnumerable(Of KeyValuePair(Of String, RetrievedDataSet))

         images = client.RetrieveImages("", "") 'perform a wild card search


         For Each imageInformation As KeyValuePair(Of String, RetrievedDataSet) In images
             Console.WriteLine("SOPInstanceUID: {0}", imageInformation.Key)
             Console.WriteLine(imageInformation.Value.DataSetFilePath)
             Console.WriteLine("---------------------------------------------")
         Next imageInformation

     End Sub
C#Copy Code
public void RetrieveLocalDatabase() 

   Leadtools.Examples.Support.Unlock(); 
 
   AeInfo clientInfo = new AeInfo ( ); 
 
 
   clientInfo.Address = Dns.GetHostName(); //local machine 
   clientInfo.AETitle = "TEST_CLIENT" ; 
   clientInfo.Port    = 1000 ; 
 
   //Make sure that the MoveAddIn is configured properly before using this class. 
   DbRetrieveClient client = new DbRetrieveClient (clientInfo); 
 
   client.LoadRetrievedDataSet = false; //Enable this if you need to read information from the DICOM dataset. 
 
   client.EnableLog = true; 
   client.LogFileName = ( @"c:\DicomLog.txt" ) ; 
 
   PerformClientRetrieve(client); 

 
public void PerformClientRetrieve(RetrieveClient client)  

   IEnumerable <KeyValuePair <string, RetrievedDataSet>> images = client.RetrieveImages ( "", "" ) ; //perform a wild card search 
 
 
   foreach ( KeyValuePair <string, RetrievedDataSet> imageInformation in images )  
   { 
      Console.WriteLine ( "SOPInstanceUID: {0}", imageInformation.Key ) ; 
      Console.WriteLine ( imageInformation.Value.DataSetFilePath ) ; 
      Console.WriteLine("---------------------------------------------" ); 
   } 
}

Remarks

The RetrieveClient.InstanceReceived event will be fired when each instance is received.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also

Leadtools.Medical.Workstation.Client requires a Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features