Leadtools.Dicom Namespace > DicomPrintScu Class : UpdateImageBox Method |
public void UpdateImageBox( string imageBoxInstanceUid, DicomDataSet image, DicomImageBoxParameters parameters, string refImageOverlayBoxInstanceUid, string refPresentationLutInstanceUid )
'Declaration Public Sub UpdateImageBox( _ ByVal imageBoxInstanceUid As String, _ ByVal image As DicomDataSet, _ ByVal parameters As DicomImageBoxParameters, _ ByVal refImageOverlayBoxInstanceUid As String, _ ByVal refPresentationLutInstanceUid As String _ )
'Usage Dim instance As DicomPrintScu Dim imageBoxInstanceUid As String Dim image As DicomDataSet Dim parameters As DicomImageBoxParameters Dim refImageOverlayBoxInstanceUid As String Dim refPresentationLutInstanceUid As String instance.UpdateImageBox(imageBoxInstanceUid, image, parameters, refImageOverlayBoxInstanceUid, refPresentationLutInstanceUid)
public void UpdateImageBox( string imageBoxInstanceUid, DicomDataSet image, DicomImageBoxParameters parameters, string refImageOverlayBoxInstanceUid, string refPresentationLutInstanceUid )
ObjectiveC Syntax
function Leadtools.Dicom.DicomPrintScu.UpdateImageBox( imageBoxInstanceUid , image , parameters , refImageOverlayBoxInstanceUid , refPresentationLutInstanceUid )
public: void UpdateImageBox( String^ imageBoxInstanceUid, DicomDataSet^ image, DicomImageBoxParameters^ parameters, String^ refImageOverlayBoxInstanceUid, String^ refPresentationLutInstanceUid )
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. |
When the Print SCP is requested to create a Film Box, it will also create one or more Image Boxes, based on the Image Display Format. This method updates a particular Image Box. The Image Box specified (by the SOP Instance UID) must belong to the current (last created) Film 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 method CreateFilmSession for more information.
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 UpdateImageBox is successful, the Image Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.
The parameter parameters specifies the Image Box parameters to be updated. In the passed object, if a string property is a null reference (Nothing in Visual Basic), then the corresponding Attribute will not be included in the request to the Print SCP and hence will not be updated. Similarly, if a numeric property is negative, the corresponding Attribute will not be included in the request 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 ignore the following properties of the DicomImageBoxParameters class for Color Image Boxes:
DicomImageBoxParameters.MinDensity
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
DicomPrintScu Class
DicomPrintScu Members
CreateFilmSession Method
CreateFilmBox Method
GetImageBoxesCount Method
GetImageBoxInstanceUid Method
GetDefaultImageBoxParameters Method
FreeImageBoxesInstanceUids Method
GetLastOperationStatus Method
CreateOverlayBox Method
CreatePresentationLut Method