Leadtools.Dicom Namespace > DicomPrintScu Class : UpdateOverlayBox Method |
public void UpdateOverlayBox( string overlayBoxInstanceUid, DicomDataSet overlay, DicomOverlayBoxParameters parameters, bool updateOverlayOrigin )
'Declaration Public Sub UpdateOverlayBox( _ ByVal overlayBoxInstanceUid As String, _ ByVal overlay As DicomDataSet, _ ByVal parameters As DicomOverlayBoxParameters, _ ByVal updateOverlayOrigin As Boolean _ )
'Usage Dim instance As DicomPrintScu Dim overlayBoxInstanceUid As String Dim overlay As DicomDataSet Dim parameters As DicomOverlayBoxParameters Dim updateOverlayOrigin As Boolean instance.UpdateOverlayBox(overlayBoxInstanceUid, overlay, parameters, updateOverlayOrigin)
public void UpdateOverlayBox( string overlayBoxInstanceUid, DicomDataSet overlay, DicomOverlayBoxParameters parameters, bool updateOverlayOrigin )
ObjectiveC Syntax
function Leadtools.Dicom.DicomPrintScu.UpdateOverlayBox( overlayBoxInstanceUid , overlay , parameters , updateOverlayOrigin )
public: void UpdateOverlayBox( String^ overlayBoxInstanceUid, DicomDataSet^ overlay, DicomOverlayBoxParameters^ parameters, bool updateOverlayOrigin )
Exception Type | Condition |
---|---|
DicomExceptionCode.PrintSCUFailureStatus | The response of the Print SCP specifies a Failure status code. |
DicomExceptionCode.PrintSCUClassNotSupported | The Basic Print Image Overlay Box SOP Class is not supported on the Association. |
The method will fail if both overlay and parameters are set to null references (Nothing in Visual Basic).
The Image Overlay Box specified (by the SOP Instance UID) must be an exiting one. Refer to the method CreateOverlayBox for creating Image Overlay Boxes.
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 UpdateOverlayBox is successful, the specified Image Overlay Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.
In the DicomOverlayBoxParameters object specified by the parameter parameters, 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. Also, if the property DicomOverlayBoxParameters.MagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request and hence will not be updated.
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