UpdateAnnotationBox Method

Summary

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

Syntax

C++

public void UpdateAnnotationBox( 
   string annotationBoxInstanceUid, 
   int annotationPosition, 
   string text 
)

Public Sub UpdateAnnotationBox( _ 
   ByVal annotationBoxInstanceUid As String, _ 
   ByVal annotationPosition As Integer, _ 
   ByVal text As String _ 
)

public: 
void UpdateAnnotationBox(  
   String^ annotationBoxInstanceUid, 
   int annotationPosition, 
   String^ text 
)

Parameters

annotationBoxInstanceUid
The SOP Instance UID of the Annotation Box to be updated. The method will fail if this is a null reference (Nothing in VB) or if an empty string is specified. The method GetAnnotationBoxInstanceUid returns the SOP Instance UID of a particular Annotation Box.

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

text
The Value of the Attribute Text String (2030,0020). If this is set to a null reference (Nothing in VB), the Attribute will not be included in the request to the Print SCP and hence will not be updated.

Remarks

Two of the exceptions that can be thrown by this method are:

Exception Type	Condition
DicomExceptionCode.PrintSCUFailureStatus	The response of the Print SCP specifies a Failure status code.
DicomExceptionCode.PrintSCUClassNotSupported	The Basic Annotation Box SOP Class is not supported on the Association.

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 method updates a particular Annotation Box. The Annotation Box specified (by the SOP Instance UID) must belong to the current (last created) Film Box.

The method will not return until it receives the response of the Print SCP, or an error occurs. The method GetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. If the method UpdateAnnotationBox is successful, the Annotation Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.

Example

For an example, refer to Associate.

Requirements

Target Platforms