DicomObjects.NET10 Documentation
DicomObjects.DicomWeb Namespace / WorkItemWebClient Class / RetrieveAsync Method
The Workitem UID for matching
A token that may be used to cancel the operation
Example



In This Topic
    RetrieveAsync Method (WorkItemWebClient)
    In This Topic
    Asynchronous transaction that retrieves a Workitem. It corresponds to the UPS DIMSE N-GET operation.
    Syntax
    'Declaration
     
    
    <AsyncStateMachineAttribute(DicomObjects.DicomWeb.WorkItemWebClient/d__32)> 
    Public Function RetrieveAsync( _ 
       ByVal WorkItemUID As String, _ 
       Optional ByVal cancellationToken As CancellationToken _ 
    ) As Task(Of DicomDataSet)
    'Usage
     
    
    Dim instance As WorkItemWebClient
    Dim WorkItemUID As String
    Dim cancellationToken As CancellationToken
    Dim value As Task(Of DicomDataSet)
     
    value = instance.RetrieveAsync(WorkItemUID, cancellationToken)
    [AsyncStateMachine(DicomObjects.DicomWeb.WorkItemWebClient/d__32)] 
    public Task<DicomDataSet> RetrieveAsync( 
       string WorkItemUID, 
       CancellationToken cancellationToken 
    )
    [AsyncStateMachine(DicomObjects.DicomWeb.WorkItemWebClient/d__32)] 
    public: 
    Task<DicomDataSet^>^ RetrieveAsync( 
       String^ WorkItemUID, 
       CancellationToken cancellationToken 
    ) 

    Parameters

    WorkItemUID
    The Workitem UID for matching
    cancellationToken
    A token that may be used to cancel the operation

    Return Value

    A DicomObjects.DicomDataSet object that represents the retreived Workitem (UPS) object
    Remarks
    The async operation will return as soon as the response is available and headers are read (content is not read yet)
    Example
    WorkItemWebClient wwc = new WorkItemWebClient(BaseUri);
    var ds = wwc.Retrieve("1.2.3.4.5.6.7.8.9");
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also