OnBeforeSendCStoreRequest Method

Summary

Notifies an implementor before a DicomNet::SendCStoreRequest is sent.

Syntax

C++

public virtual void OnBeforeSendCStoreRequest( 
   DicomClient Client, 
   byte presentationID, 
   int messageID, 
   string affectedClass, 
   string instance, 
   DicomCommandPriorityType priority, 
   string moveAE, 
   int moveMessageID, 
   DicomDataSet dataSet 
)

Public Overridable Sub OnBeforeSendCStoreRequest( 
   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 dataSet As DicomDataSet 
)

public:  
   virtual void OnBeforeSendCStoreRequest( 
       DicomClient^ Client, 
      Byte presentationID, 
      Int32 messageID, 
      String^ affectedClass, 
      String^ instance, 
      DicomCommandPriorityType^ priority, 
      String^ moveAE, 
      Int32 moveMessageID, 
      DicomDataSet^ dataSet 
   )

Parameters

Client

The client this notification applies to.

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 should 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 should 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.

dataSet

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

Remarks

Override this method to view or change arguments before a DicomNet::SendCStoreRequest is sent.

This can be used with DICOM listening services in the High-level PACS Framework. For example, you can create an assembly that contains the following code, and copy the assembly into the DICOM listening service 'AddIns' folder.

public class SendNotify : NotifySendMessageBase 
{ 
   public override void OnBeforeSendCStoreRequest(DicomClient Client, byte presentationID, int messageID, string affectedClass, string instance, DicomCommandPriorityType priority, string moveAE, int moveMessageID, DicomDataSet dataSet) 
   { 
      // View or change parameters 
      base.OnBeforeSendCStoreRequest(Client, presentationID, messageID, affectedClass, instance, priority, moveAE, moveMessageID, dataSet); 
   } 
}

For a working example, see:

<LEAD Installation Folder>\Examples\DotNet\PACSFramework\CS\Sample AddIns\Leadtools.AddIn.Sample.Events

Requirements

Target Platforms

Reference

NotifySendMessageBase Class

NotifySendMessageBase Members

Leadtools.Dicom.AddIn Namespace

Download our FREE evaluation

Help Version 21.0.2021.7.2