LDicomPrintSCU::UpdateAnnotationBox

Summary

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

Syntax

L_INT LDicomPrintSCU::UpdateAnnotationBox(pszAnnotationBoxInstanceUID, uAnnotationPosition, pszTextString)

Parameters

const L_TCHAR * pszAnnotationBoxInstanceUID

Character string that contains the SOP Instance UID of the Annotation Box to be updated. The function will return an error if this is NULL or if an empty string is specified. The function LDicomPrintSCU::GetAnnotationBoxInstanceUID returns the SOP Instance UID of a particular Annotation Box.

L_UINT16 uAnnotationPosition

Specifies the Value of the Attribute Annotation Position (2030,0010).

const L_TCHAR * pszTextString

Character string that contains the Value of the Attribute Text String (2030,0020). If this is set to NULL, the Attribute will not be included in the request to the Print SCP and hence will not be updated.

Returns

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

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

See Also

Functions

• Class Members
• LDicomPrintSCU::CreateFilmBox
• LDicomPrintSCU::GetAnnotationBoxesCount
• LDicomPrintSCU::GetAnnotationBoxInstanceUID
• LDicomPrintSCU::FreeAnnotationBoxesInstanceUIDs
• LDicomPrintSCU::GetLastOperationStatus

Topics

• Print Management SCU
• DICOM Print Management Service Class User: Functions

Example

For an example, refer to LDicomPrintSCU::UpdateImageBox.