Create method (ILImageOverlayBox Interface)

Remarks

The Create method requests the Print SCP to create a Basic Print Image Overlay Box SOP Instance.

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

The Overlay data of the Image Overlay Box to be created 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 (even if the IncludedParameters property doesn’t specify OB_OVERLAY_FILENAME).

The method can be used to create one or more Image Overlay Boxes. Having an Image Overlay Box created, the GetSOPInstanceUID method can be used to obtain its SOP Instance UID, which in turn can be used to reference the Image Overlay Box from Image Boxes. Refer to the RefImageOverlayBoxInstanceUID property of the ILImageBox interface.

The Update method and Delete method can be used to update and delete Image Overlay Boxes, respectively.

Before calling the method, the various properties can be used to set the parameters of the Image Overlay Box to be created. 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. Notice that the method will use the OverlayOriginRow property and OverlayOriginColumn property to specify the Overlay Origin, even if the IncludedParameters property doesn’t specify OB_OVERLAY_ORIGIN.

See Also