In This Topic ▼

L_DicomPrintSCUUpdateAnnotationBox

Syntax

#include "ltdic.h"

L_LTDIC_API L_INT L_DicomPrintSCUUpdateAnnotationBox(hPrintSCU, pszAnnotationBoxInstanceUID, uAnnotationPosition, pszTextString)

Parameters

HDICOMPRINTSCU hPrintSCU

A handle to Dicom Print SCU.

const L_TCHAR *pszAnnotationBoxInstanceUID

SOP Instance UID of the Annotation Box.

L_UINT16 uAnnotationPosition

Position of the Annotation Box in the parent Film Box.

const L_TCHAR *pszTextString

Text string of the Annotation Box.

Returns

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

Comments

When the Print SCP is requested to create a Film Box, and if an Annotation Display Format ID is specified, the Print SCP will also create one or more Annotation Boxes, based on the Annotation Display Format ID. This will happen only if the Basic Annotation Box SOP Class is supported on the Association. This function updates a particular Annotation Box. The Annotation Box specified (by the SOP Instance UID) must belong to the current (last created) Film Box.

The function will not return until it receives the response of the Print SCP, or an error occurs. 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 UpdateAnnotationBox is 0, then the Annotation Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.