In This Topic ▼

L_DicomPrintSCUUpdateOverlayBox

Syntax

#include "ltdic.h"

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

Parameters

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.

Returns

Value	Meaning
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.