Public Sub DeleteOverlayBox( _
   ByVal overlayBoxInstanceUid As String _
) 

Visual Basic (Usage)	Copy Code
Dim instance As DicomPrintScu Dim overlayBoxInstanceUid As String   instance.DeleteOverlayBox(overlayBoxInstanceUid)

public void DeleteOverlayBox( 
   string overlayBoxInstanceUid
)

public: void DeleteOverlayBox( 
   string* overlayBoxInstanceUid
) 

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.

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: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Reference