C#
VB
C++
←Select platform
DeleteOverlayBox Method
Summary
Requests the Print SCP to delete the specified Basic Print Image Overlay Box SOP Instance.
Syntax
public void DeleteOverlayBox(string overlayBoxInstanceUid)
Public Sub DeleteOverlayBox( _ByVal overlayBoxInstanceUid As String _)
public:void DeleteOverlayBox(String^ overlayBoxInstanceUid)
Parameters
overlayBoxInstanceUid
The SOP Instance UID of the Image Overlay Box to be deleted. The method will fail if this is a null reference (Nothing in VB) or if an empty string is specified.
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 | 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.
Example
For an example, refer to Associate.
Requirements
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools.Dicom Assembly
