OnNAction2 Method

Summary

Allows the add-in to handle N-ACTION-REQ commands.

Syntax

C++

public DicomCommandStatusType OnNAction2( 
   DicomClient Client, 
   byte PresentationId, 
   int MessageID, 
   string AffectedClass, 
   string Instance, 
   int Action, 
   DicomDataSet Request, 
   DicomDataSet Response, 
   out StatusBase StatusBaseArgs 
)

Public Function OnNAction2( 
   ByVal Client As DicomClient, 
   ByVal PresentationId As Byte, 
   ByVal MessageID As Integer, 
   ByVal AffectedClass As String, 
   ByVal Instance As String, 
   ByVal Action As Integer, 
   ByVal Request As DicomDataSet, 
   ByVal Response As DicomDataSet, 
   ByRef StatusBaseArgs As StatusBase 
) As DicomCommandStatusType

public:  
   DicomCommandStatusType^ OnNAction2( 
       DicomClient^ Client, 
      Byte PresentationId, 
      Int32 MessageID, 
      String^ AffectedClass, 
      String^ Instance, 
      Int32 Action, 
      DicomDataSet^ Request, 
      DicomDataSet^ Response, 
      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.

Instance

The instance of the class. A server may, for example, have three instances of the Nuclear Medicine Class. This value identifies the data with a specific instance.

Action

An application-specific action to be performed on the specified Data Set.

Request

A DicomDataSet object that contains the Data Set on which the specified action is to be performed.

Response

Application-specific DicomDataSet containing additional information related to the 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 OnNAction2 is a replacement for the OnNAction method.

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

Checks if the IProcessNAction2 interface has been implemented by an addin. If so, then DICOM Listening Service calls the OnNAction2 method to handle the N-ACTION-REQ.
Otherwise, checks if the IProcessNAction has been implemented by an addin. If so, then DICOM Listening Service calls the OnNAction method to handle the N-ACTION-REQ.

The StatusBaseArgs argument is used to set additional optional status DICOM Elements in the N-ACTION-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

IProcessNAction2 Class

IProcessNAction2 Members

Leadtools.Dicom.AddIn.Interfaces Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2