LDicomPrintSCU::DeleteOverlayBox
#include "ltdic.h"
L_INT LDicomPrintSCU::DeleteOverlayBox(pszOverlayBoxInstanceUID)
|
const L_TCHAR * pszOverlayBoxInstanceUID; |
/* SOP Instance UID of the Image Overlay Box */ |
Requests the Print SCP to delete the specified Basic Print Image Overlay Box SOP Instance.
|
Parameter |
Description |
|
pszOverlayBoxInstanceUID |
Character string that contains the SOP Instance UID of the Image Overlay Box to be deleted. The function will return an error if this is NULL or if an empty string is specified. |
Returns
|
0 |
The specified Basic Print Image Overlay Box SOP Instance was deleted successfully. |
|
DICOM_ERROR_PRINTSCU_FAILURE_STATUS |
The response of the Print SCP specifies a Failure status code. |
|
DICOM_ERROR_PRINTSCU_CLASS_NOT_SUPPORTED |
The Basic Print Image Overlay Box SOP Class is not supported on the Association. |
|
> 0 |
An error occurred. Refer to Return Codes. |
Comments
The Image Overlay Box specified (by the SOP Instance UID) must be an exiting one. Refer to the function LDicomPrintSCU::CreateOverlayBox 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 LDicomPrintSCU::GetLastOperationStatus 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 |
See Also
Example
For an example, refer to LDicomPrintSCU::UpdateImageBox.