Create method (ILFilmBox Interface)

VB.NET example

C# example

Visual Basic example

Visual C++ 6.0 example

 

Syntax

short Create(BSTR ImageDisplayFormat);

Overview

Refer to Print Management SCU.

Remarks

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

A Film Session must have been created before creating Film 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 Film Box was created successfully, with either a Success or Warning status code in the response of the Print SCP.

Having the Film Box created, its SOP Instance UID can be obtained from the SOPInstanceUID property. Also, the Update method, PrintBox method, and Delete method can be used to update, print, and delete the Film Box, respectively.

When a Film Box is created, the Print SCP will also create one or more Image Boxes, based on the Image Display Format specified by the parameter ImageDisplayFormat. For each Image Box created, a LImageBox object will be added to the collection of Image Boxes specified by the ImageBoxes property of the ILEADDicomPrintSCU interface. The members of the ILImageBox interface (exposed by the LImageBox object) can then be used to manipulate the Image Box.

Similarly, when a Film Box is created, and if the AnnotationDisplayFormatID property is used to specify an Annotation Display Format ID, the Print SCP will also create one or more Annotation Boxes, 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 Annotation Box created, a LAnnotationBox object is added to the collection of Annotation Boxes specified by the AnnotationBoxes property of the ILEADDicomPrintSCU Interface. The members of the ILAnnotationBox Interface (exposed by the LAnnotationBox object) can then be used to manipulate the Annotation Box.

The method can be used to create more than one Film Box. However, only the current Film Box (the last one created) can be updated, printed alone, and deleted. Previous Film Boxes can only be printed by printing the whole Film Session.

Before calling the method, the various properties can be used to set the parameters of the Film 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.

See Also

Elements:

Create method (ILFilmSession interface), IncludedParameters property, SOPInstanceUID property, Update method, PrintBox method, Delete method, LastOperationStatus property, ImageBoxes property, AnnotationBoxes property

Topics:

DICOM Print Management SCU: Basic Print Management