RZDCX - Fast Strike DICOM Toolkit  Release 2.0.7.4
IDCXREQ Interface Reference

Use this interface to perfrom tasks of a DICOM Service SCU. More...

Inherits IDispatch.

Public Member Functions

HRESULT Echo ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port)
 send a DICOM C-ECHO command More...
 
HRESULT Query ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR sopClassUid, [in] IDCXOBJ *obj, [out, retval] IDCXOBJIterator **i)
 send a DICOM C-FIND command More...
 
HRESULT Send ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR fileList, [out] BSTR *succeededFilesList, [out] BSTR *failedFilesList)
 send one or more files over network connection using DICOM C-STORE commands. More...
 
HRESULT SendObject ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj)
 Send a DICOM Object Use the Send command to implement a C-STORE SCU. The SendObject command accepts a DCXOBJ. It goes over the object and check the SOP Classes and Transfer Syntaxes that should be negotiated in the Association. Then it initiates an Assocaition and sends the object. More...
 
HRESULT Move ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR targetAETitle, [in] IDCXOBJ *query)
 Send a DICOM C-MOVE command. This is a C-MOVE SCU. The Query Model that is used for the C-MOVE command is Patient Root Q/R Move Information Model. More...
 
HRESULT MovePatient ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR targetAETitle, [in] BSTR patientName, [in] BSTR patientID)
 Retrieve images of a specific patint. More...
 
HRESULT MoveStudy ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR targetAETitle, [in] BSTR patientID, [in] BSTR studyInstanceUID)
 Retrieve images of a specific study. More...
 
HRESULT MoveSeries ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR targetAETitle, [in] BSTR patientID, [in] BSTR studyInstanceUID, [in] BSTR seriesInstanceUID)
 Retrieve images of a specific series. More...
 
HRESULT MoveInstances ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR targetAETitle, [in] BSTR patientID, [in] BSTR studyInstanceUID, [in] BSTR seriesInstanceUID, [in] BSTR instanceUIDs)
 Retrieve images of a specific instance or instances. More...
 
HRESULT CommitFiles ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR fileList, [out, retval] BSTR *transactionUID)
 
HRESULT CommitInstances ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR instanceList, [out, retval] BSTR *transactionUID)
 Same as CommitFiles but with instance UID's. More...
 
HRESULT SendMPPSNCreateRequest ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj)
 send a N-CREATE Request command. More...
 
HRESULT SendMPPSNSetRequest ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj)
 send a N-SET Request command. More...
 
HRESULT StartGrayscalePrintSession ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [out, retval] IDCXPrintSession **session)
 Start a DICOM Print Session for Grayscale images printing. More...
 
HRESULT StartColorPrintSession ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [out, retval] IDCXPrintSession **session)
 Start a DICOM Print Session for Color images printing. More...
 
HRESULT EndPrintSession ()
 End the print session.
 
HRESULT QueryPatients ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR patientName, [in] BSTR patientId, [out, retval] IDCXOBJIterator **i)
 Make a Patients Query. More...
 
HRESULT QueryStudies ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR patientName, [in] BSTR patientId, [in] BSTR studyInstanceUID, [out, retval] IDCXOBJIterator **i)
 Make a Studies Query. More...
 
HRESULT QuerySeries ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR patientName, [in] BSTR patientId, [in] BSTR studyInstanceUID, [in] BSTR seriesInstanceUID, [out, retval] IDCXOBJIterator **i)
 Make a Series Query. More...
 
HRESULT QueryInstances ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR patientName, [in] BSTR patientId, [in] BSTR studyInstanceUID, [in] BSTR seriesInstanceUID, [in] BSTR sopInstanceUID, [out, retval] IDCXOBJIterator **i)
 Make a Instances Query. More...
 
HRESULT MPPS_Create ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj, [out, retval] BSTR *sopInstanceUID)
 
HRESULT MPPS_Set ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj, [in] BSTR sopInstanceUID)
 
HRESULT N_Create ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj, [in] BSTR AffectedSopClassUID, [in] BSTR AffectedSopInstanceUID, [out, retval] BSTR *sopInstanceUID)
 
HRESULT GetPrinterInfo ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [out, retval] IDCXOBJ **obj)
 Get printer status. More...
 
HRESULT StartGrayscalePrintSessionEx ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj, [out, retval] IDCXPrintSession **session)
 Same as StartGrayscalePrintSession but with extra parameters for the N-CREATE. More...
 
HRESULT StartColorPrintSessionEx ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] IDCXOBJ *obj, [out, retval] IDCXPrintSession **session)
 Same as StartColorPrintSession but with extra parameters for the N-CREATE. More...
 
HRESULT CommitFilesAndWaitForResult ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR fileList, [in] int timeToWaitForResult, [out] VARIANT_BOOL *nEventReportRecieved, [out] VARIANT_BOOL *nEventReportStatus, [out] BSTR *succeeded_instances, [out] BSTR *failed_instances, [out, retval] BSTR *transactionUID)
 Same as CommitFiles but waits for the N-EVENT-REPORT carring the result on the same association. More...
 
HRESULT CommitInstancesAndWaitForResult ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR instanceList, [in] int timeToWaitForResult, [out] VARIANT_BOOL *nEventReportRecieved, [out] VARIANT_BOOL *nEventReportStatus, [out] BSTR *succeeded_instances, [out] BSTR *failed_instances, [out, retval] BSTR *transactionUID)
 Same as CommitFilesAndWaitForResult but with instance UID's. More...
 
HRESULT MoveAndStore ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short called_port, [in] BSTR targetAETitle, [in] IDCXOBJ *query, [in] unsigned short calling_port, [in] IDCXACC *inAssocAccepter)
 Send a DICOM C-MOVE command and handle incomming association on provided port. More...
 
HRESULT CommitFilesEx ([in] BSTR callingTitle, [in] BSTR calledTitle, [in] BSTR host, [in] unsigned short port, [in] BSTR fileList, [in, out] BSTR *transactionUID)
 Same as CommitFiles but the transaction UID can be provided by the caller. More...
 

Properties

pVal AssociationRequestTimeout [get]
 
pVal DimseCommandTimeout [get]
 

Detailed Description

Use this interface to perfrom tasks of a DICOM Service SCU.

This interface provides methods to do many SCU (client) tasks such as sending DICOM files over a network connection, doing DICOM queries and retrieving DICOM files. Many of the methods take the association parameters calling AE title, called AE title host and port. These methods starts a new association, perform the command and close the association.

Member Function Documentation

◆ CommitFilesEx()

HRESULT IDCXREQ::CommitFilesEx ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] BSTR  fileList,
[in, out] BSTR *  transactionUID 
)

Same as CommitFiles but the transaction UID can be provided by the caller.

Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
fileListA list of file (; separated) to commit
transactionUIDInput/Output Transaction UID. Use this UID to identify the Results when they arrive. If not provided, a new UID is generated. Otherwise the provided UID is used.

◆ CommitInstances()

HRESULT IDCXREQ::CommitInstances ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] BSTR  instanceList,
[out, retval] BSTR *  transactionUID 
)

Same as CommitFiles but with instance UID's.

The list of instances should be constructed as follows: sop class of file 1;sop instance of file 1;sop class of file 2; ...

Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
instanceListSemi-colon (;) separated list constructed of pairs of sop-classes and instances UID's to commit
transactionUIDOutput Transaction UID. Use this UID to identify the Results when they arrive

◆ Echo()

HRESULT IDCXREQ::Echo ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port 
)

send a DICOM C-ECHO command

Request association and if accepted send a C-ECHO command and close the association.

DICOM Conformance:
  • Requested Presentation Contexts: Verification SOP Class 1.2.840.10008.1.1
  • Proposed Transfer Syntaxes: LEI, LEE, BEE
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to

◆ GetPrinterInfo()

HRESULT IDCXREQ::GetPrinterInfo ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[out, retval] IDCXOBJ **  obj 
)

Get printer status.

Precondition
An association with the printer or a print session must be active. This method send a N-GET request to the printer to get the pirnter information module
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objOutput Printer Info Object

◆ MPPS_Create()

HRESULT IDCXREQ::MPPS_Create ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] IDCXOBJ obj,
[out, retval] BSTR *  sopInstanceUID 
)
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objThe object
sopInstanceUIDOutput SOP Instance UID of the created PPS. Note that the UID is generated

◆ MPPS_Set()

HRESULT IDCXREQ::MPPS_Set ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] IDCXOBJ obj,
[in] BSTR  sopInstanceUID 
)
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objThe object SOP Instance UID that was received from SendMPPSNCreateRequest
sopInstanceUIDThe SOP Instance of the PPS to update as returned from MPPS_Create.

◆ N_Create()

HRESULT IDCXREQ::N_Create ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] IDCXOBJ obj,
[in] BSTR  AffectedSopClassUID,
[in] BSTR  AffectedSopInstanceUID,
[out, retval] BSTR *  sopInstanceUID 
)
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objThe object
AffectedSopClassUIDThe SOP Class of the provided object
AffectedSopInstanceUIDIf not empty string, sent to the SCP, otherwise Affected SOP Class is allocated by SCP.
sopInstanceUIDOutput SOP Instance UID of the created Instance. If AffectedSopClassUID is porivded this value should be the same

◆ SendMPPSNCreateRequest()

HRESULT IDCXREQ::SendMPPSNCreateRequest ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] IDCXOBJ obj 
)

send a N-CREATE Request command.

Deprecated:
The MPPS N-CREATE is now implemented by IDCXREQ::MPPS_Create() and MPPS N-SET by IDCXREQ::MPPS_Set()
Precondition
The object must be a valid MPPS object and specifically the tag Affected SOP Instance UID (0000,1000) must be present and not 0 length
DICOM Conformance:
  • Requested Presentation Contexts:
    • Verification SOP Class - 1.2.840.10008.1.1
    • Modality Performed Procedure Step SOP Class - 1.2.840.10008.3.1.2.3.3
  • Proposed Transfer Syntaxes (for all verification and C-MOVE Model SOP Class):
    • Little Endian Implicit - 1.2.840.10008.1.2
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objThe object

◆ SendMPPSNSetRequest()

HRESULT IDCXREQ::SendMPPSNSetRequest ( [in] BSTR  callingTitle,
[in] BSTR  calledTitle,
[in] BSTR  host,
[in] unsigned short  port,
[in] IDCXOBJ obj 
)

send a N-SET Request command.

Deprecated:
The MPPS N-CREATE is now implemented by MPPS_Create and IDCXREQ::MPPS N-SET by IDCXREQ::MPPS_Set
Precondition
The object must be a valid MPPS object and specifically the tag Requested SOP Instance UID (0000,1001) must be present and not 0 length
DICOM Conformance:
  • Requested Presentation Contexts:
    • Verification SOP Class - 1.2.840.10008.1.1
    • Modality Performed Procedure Step SOP Class - 1.2.840.10008.3.1.2.3.3
  • Proposed Transfer Syntaxes (for all verification and C-MOVE Model SOP Class):
    • Little Endian Implicit - 1.2.840.10008.1.2
Parameters
callingTitleCalling AE Title (us)
calledTitleCalled AE Title (them)
hostHost name or IP address (their)
portThe port number they are listening to
objThe object SOP Instance UID that was received from SendMPPSNCreateRequest

Property Documentation

◆ AssociationRequestTimeout [1/2]

pVal IDCXREQ::AssociationRequestTimeout
getproperty

Association Request Timeout (ARTM) is the time to wait for a response after sending A-ASSOCIATE commands The timeout set here affects only this instance

◆ AssociationRequestTimeout [2/2]

newVal IDCXREQ::AssociationRequestTimeout
setproperty

◆ DimseCommandTimeout [1/2]

pVal IDCXREQ::DimseCommandTimeout
getproperty

DIMSE Command Timeout is the time to wait for a response after sending a DICOM Message Exchange Command The timeout set here affects only this instance

◆ DimseCommandTimeout [2/2]

newVal IDCXREQ::DimseCommandTimeout
setproperty