OnStore2 Method

Summary

Allows the add-in to handle C-STORE-REQ commands.

Syntax

C++

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

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

public:  
   DicomCommandStatusType^ OnStore2( 
       DicomClient^ Client, 
      Byte PresentationId, 
      Int32 MessageId, 
      String^ AffectedClass, 
      String^ Instance, 
      DicomCommandPriorityType^ Priority, 
      String^ MoveAE, 
      Int32 MoveMessageId, 
      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.

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.

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.

MoveAE

The name of the Application Entity that originally requested the move. For a simple storage request from a client to a server, this will be an empty string. When the request is a sub-operation of a C-MOVE, this will contain the name of the AE that requested the move.

MoveMessageId

The ID of the original move request message. For a simple storage request from a client to a server, this will be 0. When the request is a sub-operation of a C-MOVE, this will contain the original message ID of the C-MOVE request.

Request

A DicomDataSet object that contains the Data Set to be stored.

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 OnStore2 is a replacement for the OnStore method.

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

Checks if the IProcessCStore2 interface has been implemented by an addin. If so, then DICOM Listening Service calls the OnStore2 method to handle the C-STORE-REQ.
Otherwise, checks if the IProcessCStore has been implemented by an addin. If so, then DICOM Listening Service calls the OnStore method to handle the C-STORE-REQ.

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

IProcessCStore2 Class

IProcessCStore2 Members

Leadtools.Dicom.AddIn.Interfaces Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2