GetPrintJobInformation Method

public DicomPrintJobInformation GetPrintJobInformation( 
   string printJobInstanceUid,
   DicomPrintJobInformation requiredPrintJobInformation
)

'Declaration
 

Public Function GetPrintJobInformation( _
   ByVal printJobInstanceUid As String, _
   ByVal requiredPrintJobInformation As DicomPrintJobInformation _
) As DicomPrintJobInformation

'Usage
 

Dim instance As DicomPrintScu
Dim printJobInstanceUid As String
Dim requiredPrintJobInformation As DicomPrintJobInformation
Dim value As DicomPrintJobInformation
 
value = instance.GetPrintJobInformation(printJobInstanceUid, requiredPrintJobInformation)

public DicomPrintJobInformation GetPrintJobInformation( 
   string printJobInstanceUid,
   DicomPrintJobInformation requiredPrintJobInformation
)

 function Leadtools.Dicom.DicomPrintScu.GetPrintJobInformation( 
   printJobInstanceUid ,
   requiredPrintJobInformation 
)

public:
DicomPrintJobInformation^ GetPrintJobInformation( 
   String^ printJobInstanceUid,
   DicomPrintJobInformation^ requiredPrintJobInformation
) 

Parameters

printJobInstanceUid

The SOP Instance UID of the Print Job whose information is to be retrieved. The method will fail if this is a null reference (Nothing in Visual Basic) or if an empty string is specified.

requiredPrintJobInformation

A DicomPrintJobInformation object that specifies the Print Job information to be retrieved. If this is set to a null reference (Nothing in Visual Basic), then it will be assumed that the Values of all the Attributes are required.

Return Value

The method will not return until it receives the response of the Print SCP, or an error occurs. The method GetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. If the method GetPrintJobInformation is successful, the required Print Job information was retrieved successfully, with either a Success or Warning status code in the response of the Print SCP.

The parameter requiredPrintJobInformation specifies the Print Job information to be retrieved. In the DicomPrintJobInformation class, all properties are strings. To query the Print SCP for the Value of an Attribute, the corresponding property, in the passed object, mustn't be a null reference (Nothing in Visual Basic); it can be set to an empty string for example. If a property is a null reference, the corresponding Attribute will not be included in the request. However, if all the properties are set to null references, the Print SCP will be queried for the Values of all the Attributes.

Target Platforms

Reference

DicomPrintScu Class
DicomPrintScu Members
GetPrintJobInstanceUid Method
OnPrintJobReport Method
GetLastOperationStatus Method