In This Topic ▼

L_DicomPrintSCUCreateOverlayBox

Syntax

#include "ltdic.h"

L_LTDIC_API L_INT L_DicomPrintSCUCreateOverlayBox(hPrintSCU, pOverlay, pParameters)

Parameters

HDICOMPRINTSCU hPrintSCU

A handle to Dicom Print SCU.

HDICOMDS pOverlay

Image overlay.

const pOVERLAYBOXPARAMETERS pParameters

Image Overlay parameters.

Returns

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

Comments

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

The function can be used to create one or more Image Overlay Boxes. Having an Image Overlay Box created, the function L_DicomPrintSCUGetOverlayBoxInstanceUID can be used to obtain its SOP Instance UID, which in turn can be used to reference the Image Overlay Box from Image Boxes. Refer to the function L_DicomPrintSCUUpdateImageBox.

The functions L_DicomPrintSCUUpdateOverlayBox and L_DicomPrintSCUDeleteOverlayBox can be used to update and delete Image Overlay Boxes, respectively.

The parameter pParameters points to an pOVERLAYBOXPARAMETERS structure that specifies the parameters to be used when creating the Image Overlay Box. The structure members nOverlayOriginRow and nOverlayOriginColumn will always be used to specify the Overlay Origin (6000,0050); these can be negative. If a string member of the structure is NULL, then the corresponding Attribute will not be included in the request to the Print SCP. Also, if the member nMagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request.