Update method (ILImageBox Interface)
|
Overview |
Refer to Print Management SCU. |
Remarks
The Update method requests the Print SCP to update the Image Box.
When the Print SCP is requested to create a Film Box, it will also create one or more Basic Grayscale/Color Image Box SOP Instances, based on the Image Display Format. For each Instance created, an LImageBox object is added to the collection of Image Boxes specified by the ImageBoxes property. This method updates the Image Box.
The type of the Image Boxes created by the Print SCP (Grayscale or Color) depends on the Meta SOP Class of the Film Session created at first. Refer to the Create method of the ILFilmSession interface for more information.
The method will not return until it receives the response of the Print SCP or an error occurs. The status code specified in the response of the Print SCP is given by the LastOperationStatus property. When the return value of the method is 0, then this means that the Image Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.
The image to be printed in the Image Box can be specified either by using the Image parameter or by using the ImageFilename property. However, the parameter is always given the priority. Therefore, the method will inspect the parameter first; if it is not supplied or if it doesn’t specify neither a character string nor a long value, the method will use the property if the IncludedParameters property specifies IB_IMAGE_FILENAME. If this is not specified, the Print SCP will be instructed to erase the image (if there is one) in the Image Box.
The method will return an error if the ImagePosition property is set to a value less than 1.
Before calling the method, the various properties can be used to set the parameters to be updated. Only those parameters specified by the IncludedParameters property will be included. If a parameter is not specified, the corresponding Attribute will not be included in the request to the Print SCP and hence will not be updated. Notice that since the Attributes Min Density, Max Density, and Configuration Information are defined only for Grayscale Image Boxes, the method will always ignore the following properties if the Image Box is a Color one:
ConfigurationInformation property
See Also
|
Elements: |
Create method (ILFilmSession interface), Create method (ILFilmBox interface), ImageBoxes property, IncludedParameters property, ImageFilename property, ImagePosition property, SOPInstanceUID property, LastOperationStatus property |
|
Topics: |