L_DicomPrintSCUUpdateOverlayBox

#include "ltdic.h"

L_LTDIC_API L_INT L_DicomPrintSCUUpdateOverlayBox(hPrintSCU, pszOverlayBoxInstanceUID, pOverlay, pParameters, bUpdateOverlayOrigin)

HDICOMPRINTSCU hPrintSCU; A handle to Dicom Print SCU.
const L_TCHAR *pszOverlayBoxInstanceUID; SOP Instance UID of the Image Overlay Box.
HDICOMDS pOverlay; Image Overlay
const pOVERLAYBOXPARAMETERS pParameters; Image Overlay Box parameters to be updated.
L_BOOL bUpdateOverlayOrigin; Whether to update the Overlay Origin.

Parameter Description
hPrintSCU A handle to Dicom Print SCU
pszOverlayBoxInstanceUID SOP Instance UID of the Image Overlay Box.
pOverlay Image Overlay
pParameters Image Overlay Box parameters to be updated.
bUpdateOverlayOrigin Whether to update the Overlay Origin.

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 UpdateOverlayBox is 0, then the specified Image Overlay Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.

In the OVERLAYBOXPARAMETERS structure specified by the parameter pParameters, if a string member is NULL, then the corresponding Attribute will not be included in the request to the Print SCP and will not be updated. Also, if the member nMagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request and will not be updated.

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