GetPrintJobInstanceUid Method

Summary

Returns the SOP Instance UID of the last Print Job SOP Instance.

Syntax

C++

public string GetPrintJobInstanceUid()

Public Function GetPrintJobInstanceUid() As String

public: 
String^ GetPrintJobInstanceUid();

Return Value

The SOP Instance UID of the Print Job SOP Instance resulted from the last successful printing request sent to the Print SCP. If no Print Job was created by the Print SCP for the last printing request, the method will return an empty string.

Remarks

Each of the methods PrintFilmSession and PrintFilmBox requests the Print SCP to print one or more films. If the Print Job SOP Class is supported on the Association, the Print SCP is supposed to create a Print Job SOP Instance for the new Print Job and send the SOP Instance UID of that Instance in the response to the printing request. The method GetPrintJobInstanceUid returns that SOP Instance UID. The SOP Instance UID of a Print Job can be used to query the Print SCP for information about the Print Job (refer to the method GetPrintJobInformation). Also, it is used to identify the Print Job when status reports are received from the Print SCP (refer to the callback method OnPrintJobReport).

Example

For an example, refer to Associate.

Requirements

Target Platforms