GetPrinterInformation Method

Summary

Queries the Print SCP for information about the printer and returns the retrieved information.

Syntax

C++

public DicomPrinterInformation GetPrinterInformation( 
   DicomPrinterInformation requiredPrinterInformation, 
   bool colorPrintManagement 
)

Public Function GetPrinterInformation( _ 
   ByVal requiredPrinterInformation As DicomPrinterInformation, _ 
   ByVal colorPrintManagement As Boolean _ 
) As DicomPrinterInformation

public: 
DicomPrinterInformation^ GetPrinterInformation(  
   DicomPrinterInformation^ requiredPrinterInformation, 
   bool colorPrintManagement 
)

Parameters

requiredPrinterInformation
A DicomPrinterInformation object that specifies the printer information to be retrieved. If this is set to a null reference (Nothing in VB), then it will be assumed that the Values of all the Attributes are required.

colorPrintManagement
true to recommend the Basic Color Print Management Meta SOP Class to be specified in the request to the Print SCP; false to recommend the Basic Grayscale Print Management Meta SOP Class. More details are given below.

Return Value

A DicomPrinterInformation object that specifies the printer information sent by the Print SCP. If an Attribute was not included in the response of the Print SCP, the corresponding property, in the returned object, is set to an empty string.

Remarks

Two of the exceptions that can be thrown by this method are:

Exception Type	Condition
DicomExceptionCode.PrintSCUFailureStatus	The response of the Print SCP specifies a Failure status code.
DicomExceptionCode.PrintSCUClassNotSupported	Neither the Basic Grayscale Print Management Meta SOP Class nor the Basic Color Print Management Meta SOP Class is supported on the Association, and hence the Printer SOP Class is not supported.

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 GetPrinterInformation was successful, the required printer information was retrieved successfully, with either a Success or Warning status code in the response of the Print SCP.

The parameter requiredPrinterInformation specifies the printer information to be retrieved. In the DicomPrinterInformation 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 VB); 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.

The Printer SOP Class is included in both the Basic Grayscale Print Management Meta SOP Class, as well as the Basic Color Print Management Meta SOP Class. The parameter colorPrintManagement recommends the Meta SOP Class to be specified in the request to the Print SCP. However, unless the Meta SOP Class specified by this parameter is supported on the Association, it will not be specified in the request and the method will choose the supported Meta SOP Class instead. Therefore, if only one Meta SOP Class is supported, the method will always choose it irrespective of the value of this parameter.

Example

For an example, refer to Associate.

Requirements

Target Platforms