#include "ltdic.h"
L_INT LDicomPrintSCU::UpdateAnnotationBox(pszAnnotationBoxInstanceUID, uAnnotationPosition, pszTextString)
Requests the Print SCP to update the specified Basic Annotation Box SOP Instance.
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.
Specifies the Value of the Attribute Annotation Position (2030,0010).
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.
Value | Meaning |
---|---|
0 | The specified Basic Annotation 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 Annotation Box SOP Class is not supported on the Association. |
> 0 | An error occurred. Refer to Return Codes. |
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
Win32, x64
For an example, refer to LDicomPrintSCU::UpdateImageBox.
Help Collections
Raster .NET | C API | C++ Class Library | HTML5 JavaScript
Document .NET | C API | C++ Class Library | HTML5 JavaScript
Medical .NET | C API | C++ Class Library | HTML5 JavaScript
Medical Web Viewer .NET
Multimedia
Direct Show .NET | C API | Filters
Media Foundation .NET | C API | Transforms
Supported Platforms
.NET, Java, Android, and iOS/macOS Assemblies
Imaging, Medical, and Document
C API/C++ Class Libraries
Imaging, Medical, and Document
HTML5 JavaScript Libraries
Imaging, Medical, and Document