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



Gets or sets a value that indicates whether to load the retrieved DicomDataSet.

Syntax

Visual Basic (Declaration) 
Public Property LoadRetrievedDataSet As Boolean
Visual Basic (Usage)Copy Code
Dim instance As RetrieveClient
Dim value As Boolean
 
instance.LoadRetrievedDataSet = value
 
value = instance.LoadRetrievedDataSet
C# 
public bool LoadRetrievedDataSet {get; set;}
C++/CLI 
public:
property bool LoadRetrievedDataSet {
   bool get();
   void set (bool value);
}

Return Value

True to load the DicomDataSet when retrieved; otherwise it is false. The default is false.

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

Property ValueComments
TrueRetrieveClient class loads the retrieved DicomDataSet object. It is sent in the RetrieveClient.InstanceReceived event along with the return result from the RetrieveImages method.
False Only the DicomDataSet path will be available in the DicomDataSet object. It is sent in the RetrieveClient.InstanceReceived event along with the return result from the RetrieveImages method.

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