Update method (ILImageOverlayBox Interface)

VB.NET example	C# example
Visual Basic example	Visual C++ 6.0 example

Syntax	short Update(BSTR pszSOPInstanceUID, VARIANT Overlay);
Overview	Refer to Print Management SCU.

Remarks

The Update method requests the Print SCP to update the specified Basic Print Image Overlay Box SOP Instance.

The Image Overlay Box specified (by the SOP Instance UID) must be an exiting one. Refer to the Create method for creating Image Overlay Boxes.

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 specified Image Overlay Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.

If the Overlay data of the specified Image Overlay Box is not to be updated, the Overlay parameter should be omitted and the IncludedParameters property shouldn’t specify OB_OVERLAY_FILENAME. Otherwise, the Overlay data can be specified either by using the Overlay parameter or by using the OverlayFilename property. However, the parameter is always given the priority. Therefore, the method will inspect the parameter first; if it is omitted or if it doesn’t specify neither a character string nor a long value, the method will use the property if the IncludedParameters property specifies OB_OVERLAY_FILENAME.

Before calling the method, the various properties can be used to set the parameters to be updated. Only those parameters specified by the IncludedParameters property will be included. If a parameter is not specified, the corresponding Attribute will not be included in the request to the Print SCP and hence will not be updated.

Elements:	Create method, OverlayFilename property, IncludedParameters property, GetSOPInstanceUID method, Delete method, LastOperationStatus property
Topics:	DICOM Print Management SCU: Basic Print Management