OnGet2 Method

Summary

Allows the add-in to handle a C-GET-REQ command.

Syntax

C++

public DicomCommandStatusType OnGet2( 
   DicomClient Client, 
   byte PresentationId, 
   int MessageId, 
   string AffectedClass, 
   DicomCommandPriorityType Priority, 
   DicomDataSet Request, 
   out StatusBase StatusBaseArgs 
)

Public Function OnGet2( 
   ByVal Client As DicomClient, 
   ByVal PresentationId As Byte, 
   ByVal MessageId As Integer, 
   ByVal AffectedClass As String, 
   ByVal Priority As DicomCommandPriorityType, 
   ByVal Request As DicomDataSet, 
   ByRef StatusBaseArgs As StatusBase 
) As DicomCommandStatusType

public:  
   DicomCommandStatusType^ OnGet2( 
       DicomClient^ Client, 
      Byte PresentationId, 
      Int32 MessageId, 
      String^ AffectedClass, 
      DicomCommandPriorityType^ Priority, 
      DicomDataSet^ Request, 
      StatusBase^ %StatusBaseArgs 
   )

Parameters

Client

The client that sent the command.

PresentationId

The Presentation Context ID. The ID provides information about both the class type of the data and the Transfer Syntax to use when transferring the data.

MessageId

The Message ID. Each message sent by a member of a connection should have a unique ID. Since a member of a connection may send several messages, this ID allows that member to identify when a specific request has been completed.

AffectedClass

The class affected by the request. This will be a SOP Class or a Meta SOP Class.

Priority

The priority level of the message. The Service Class Provider may or may not support priority. Therefore, setting this parameter may or may not have any effect.

Request

A DicomDataSet that encodes attributes providing status information about the C-GET operation.

StatusBaseArgs

An object derived from StatusBase that contains the optional status DICOM Elements to be added to the command set. This is returned by the implementor.

Return Value

A DicomCommandStatusType representing the outcome of processing.

Remarks

The OnGet2 is a replacement for the OnGet method.

When the DICOM Listening Service (Leadtools.Dicom.Server.exe) gets a C-GET-REQ, it does the following:

Checks if the IProcessCGet2 interface has been implemented by an addin. If so, then DICOM Listening Service calls the OnGet2 method to handle the C-GET-REQ.
Otherwise, checks if the IProcessCGet has been implemented by an addin. If so, then DICOM Listening Service calls the OnGet method to handle the C-GET-REQ.

The StatusBaseArgs argument is used to set additional optional status DICOM Elements in the C-GET-RSP command set.

If the return value is DicomCommandStatusType.Success, then the out argument StatusBaseArgs should return an instance of StatusBase.

If the return value is not DicomCommandStatusType.Success, then the out argument StatusBaseArgs should be an instance of one of the following StatusBase derived classes:

Requirements

Target Platforms

Reference

IProcessCGet2 Class

IProcessCGet2 Members

Leadtools.Dicom.AddIn.Interfaces Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2