Leadtools.Dicom Namespace > DicomPrintScu Class : DeleteOverlayBox Method |
public void DeleteOverlayBox( string overlayBoxInstanceUid )
'Declaration Public Sub DeleteOverlayBox( _ ByVal overlayBoxInstanceUid As String _ )
'Usage Dim instance As DicomPrintScu Dim overlayBoxInstanceUid As String instance.DeleteOverlayBox(overlayBoxInstanceUid)
public void DeleteOverlayBox( string overlayBoxInstanceUid )
ObjectiveC Syntax
function Leadtools.Dicom.DicomPrintScu.DeleteOverlayBox( overlayBoxInstanceUid )
public: void DeleteOverlayBox( String^ overlayBoxInstanceUid )
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 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 DeleteOverlayBox is successful, the specified Image Overlay Box was deleted successfully, with either a Success or Warning status code in the response of the Print SCP.
Once an Image Overlay Box is deleted, it cannot be referenced by Image Boxes.
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