L_DicomPrintSCUDeleteOverlayBox

#include "ltdic.h"

L_LTDIC_API L_INT L_DicomPrintSCUDeleteOverlayBox(hPrintSCU, pszOverlayBoxInstanceUID)

HDICOMPRINTSCU hPrintSCU; A handle to Dicom Print SCU.
const L_TCHAR *pszOverlayBoxInstanceUID; SOP Instance UID of the Image Overlay Box.

Parameter Description
hPrintSCU A handle to Dicom Print SCU.
pszOverlayBoxInstanceUID SOP Instance UID of the Image Overlay Box.

Returns

SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

The Image Overlay Box specified (by the SOP Instance UID) must be an existing one. Refer to the function L_DicomPrintSCUCreateOverlayBox for creating Image Overlay Boxes.

The function will not return until it receives the response of the Print SCP, or an error occurs. The function L_DicomPrintSCUGetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. When the return value of the function DeleteOverlayBox is 0, then 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.

Required DLLs and Libraries

LTDIC
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Linux.

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS DICOM C API Help