LEADTOOLS Medical (Leadtools.Dicom assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
DeleteOverlayBox Method
See Also 
Leadtools.Dicom Namespace > DicomPrintScu Class : DeleteOverlayBox Method



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 Visual Basic) or if an empty string is specified.
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 Visual Basic) or if an empty string is specified.
Requests the Print SCP to delete the specified Basic Print Image Overlay Box SOP Instance.

Syntax

Visual Basic (Declaration) 
Public Sub DeleteOverlayBox( _
   ByVal overlayBoxInstanceUid As String _
) 
Visual Basic (Usage)Copy Code
Dim instance As DicomPrintScu
Dim overlayBoxInstanceUid As String
 
instance.DeleteOverlayBox(overlayBoxInstanceUid)
C# 
public void DeleteOverlayBox( 
   string overlayBoxInstanceUid
)
C++/CLI 
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 Visual Basic) or if an empty string is specified.

Example

For an example, refer to DicomPrintScu.Associate.

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 Leadtools.Dicom.DicomPrintScu.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 Leadtools.Dicom.DicomPrintScu.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.

Requirements

Target Platforms: Silverlight 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7, MAC OS/X (Intel Only)

See Also

Leadtools.Dicom requires a Medical toolkit server license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features