In This Topic ▼

LDicomPrintSCU::UpdateOverlayBox

Summary

Requests the Print SCP to update the specified Basic Print Image Overlay Box SOP Instance.

Syntax

#include "ltdic.h"

L_INT LDicomPrintSCU::UpdateOverlayBox(pszOverlayBoxInstanceUID, pOverlay, pParameters, bUpdateOverlayOrigin)

Parameters

const L_TCHAR * pszOverlayBoxInstanceUID

Character string that contains the SOP Instance UID of the Image Overlay Box to be updated. The function will return an error if this is NULL or if an empty string is specified.

LDicomDS* pOverlay

Pointer to an LDicomDS object that contains the Overlay data for the specified Image Overlay Box. The object is assumed to contain the Overlay Pixel Data Sequence (2040,0020); the function will return an error if this Sequence is not present. This parameter can be set to NULL if the Overlay data is not to be updated.

const pOVERLAYBOXPARAMETERS pParameters

Pointer to an OVERLAYBOXPARAMETERS structure that specifies the Image Overlay Box parameters to be updated. This can be set to NULL if none of the parameters is to be updated.

The function will return an error if both pOverlay and pParameters are set to NULL.

L_BOOL bUpdateOverlayOrigin

Specifies whether to update the Overlay Origin (6000,0050) as determined by the members nOverlayOriginRow and nOverlayOriginColumn of the structure specified by pParameters (these members can be negative). The Overlay Origin will be updated if bUpdateOverlayOrigin is TRUE; otherwise, it will not be updated and the Attribute will not be included in the request to the Print SCP. If pParameters is set to NULL, bUpdateOverlayOrigin will be ignored.

Returns

Value	Meaning
0	The specified Basic Print Image Overlay Box SOP Instance was updated 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 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 hence will not be updated. Also, if the member nMagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request and hence will not be updated.