QueryCompositeInstancesAsync Method

Summary

Asynchronously performs a query to find the composite instance information with the specified matching parameters.

Syntax

C++

public override bool QueryCompositeInstancesAsync( 
   MatchingParameterCollection matchingEntitiesCollection, 
   QueryPageInfo queryPageInfo 
)

Public Overrides Function QueryCompositeInstancesAsync( 
   ByVal matchingEntitiesCollection As MatchingParameterCollection, 
   ByVal queryPageInfo As QueryPageInfo 
) As Boolean

public:  
   virtual bool QueryCompositeInstancesAsync( 
      MatchingParameterCollection^ matchingEntitiesCollection, 
      QueryPageInfo^ queryPageInfo 
   ) override

Parameters

matchingEntitiesCollection

A MatchingParameterCollection which includes the matching parameters for the query.

queryPageInfo

Type: QueryPageInfo

Specifies the page number and page size that will result from the executing the query.

Return Value

true if query is successfully being performed, false if the query was already being executed

Remarks

This is an asynchronous version of QueryCompositeInstances(MatchingParameterCollection) that can optionally paginate the results, via QueryPageInfo. The QueryCompositeInstancesStarting event will be fired immediately upon a successful call to QueryCompositeInstancesAsync. When completed, the QueryCompositeInstancesCompleted is fired. To cancel execution, call the CancelQueryCompositeInstancesAsync method.

The matchingEntitiesCollection can be from any level and they are not limited to the Composite instance level. Which means you can query for Composite instance using the Patient ID in the patient level or study Instance UID in the study level.

This method will include all the information for the patient, study and series and Composite instance levels.

For more information about the tables returned for the patient level see the QueryPatients(MatchingParameterCollection) method. For more information about the tables returned for the study level see the QueryStudies(MatchingParameterCollection) method. For more information about the tables returned for the series level see the QuerySeries(MatchingParameterCollection) method.

The following tables in the CompositeInstanceDataSet will contain the Composite instance information: Instance, ImageInstance and ReferencedImages.

Requirements

Target Platforms