Update method (ILAnnotationBox Interface)
short Update(VARIANT_BOOL bUpdateTextString); | |
Overview |
Refer to Print Management SCU. |
Remarks
The Update method requests the Print SCP to update the Annotation Box.
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 Basic Annotation Box SOP Instances, based on the Value of the Annotation Display Format ID. This is true given that the Basic Annotation Box SOP Class is supported on the Association. For each Instance created, an LAnnotationBox object is added to the collection of Annotation Boxes specified by the AnnotationBoxes property. This method updates the Annotation Box.
The method will not return until it receives the response of the Print SCP or an error occurs. The status code specified in the response of the Print SCP is given by the LastOperationStatus property. When the return value of the method is 0, then this means that the Annotation Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.
Before calling the method, the Annotation Position and Text String of the Annotation Box can be specified using the AnnotationPosition property and TextString property, respectively.
See Also
Elements: |
Create method (ILFilmBox interface), AnnotationBoxes property, SOPInstanceUID property, LastOperationStatus property |
Topics: |