CreateFilmBox Method

Summary

Requests the Print SCP to create a Basic Film Box SOP Instance.

Syntax

C++

public void CreateFilmBox( 
   DicomFilmBoxParameters parameters, 
   string refPresentationLutInstanceUid 
)

Public Sub CreateFilmBox( _ 
   ByVal parameters As DicomFilmBoxParameters, _ 
   ByVal refPresentationLutInstanceUid As String _ 
)

public: 
void CreateFilmBox(  
   DicomFilmBoxParameters^ parameters, 
   String^ refPresentationLutInstanceUid 
)

Parameters

parameters
A DicomFilmBoxParameters object that specifies the parameters of the Film Box to be created. The method will fail if this parameter is set to a null reference (Nothing in VB) or if the Image Display Format is not specified.

refPresentationLutInstanceUid
The SOP Instance UID of a previously created Presentation LUT SOP Instance to be referenced by the Film Box. If this is set to a null reference (Nothing in VB), the corresponding Attribute will not be included in the request to the Print SCP. For creating Presentation LUTs, refer to the method CreatePresentationLut.

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; no Instance was created.
DicomExceptionCode.PrintSCUClassNotSupported	Neither the Basic Grayscale Print Management Meta SOP Class nor the Basic Color Print Management Meta SOP Class is supported on the Association.

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 method GetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. If the method CreateFilmBox is successful, 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, the method GetFilmBoxInstanceUid can be used to obtain its SOP Instance UID. Also, the methods UpdateFilmBox, PrintFilmBox, and DeleteFilmBox 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 passed DicomFilmBoxParameters object. An array of the SOP Instance UIDs of these Image Boxes is kept internally. The following methods can be used to handle the Image Boxes:

GetImageBoxesCount

GetImageBoxInstanceUid

UpdateImageBox

GetDefaultImageBoxParameters

FreeImageBoxesInstanceUids

Similarly, when a Film Box is created, and if the passed DicomFilmBoxParameters object specifies an Annotation Display Format ID, the Print SCP will also create one or more Annotation Boxes, based on the Value of that Attribute. This is true given that the Basic Annotation Box SOP Class is supported on the Association. An array of the SOP Instance UIDs of these Annotation Boxes is kept internally. The following methods can be used to handle the Annotation Boxes:

GetAnnotationBoxesCount

GetAnnotationBoxInstanceUid

UpdateAnnotationBox

FreeAnnotationBoxesInstanceUids

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.

The parameter parameters specifies the parameters to be used when creating the Film Box. In the passed object, if a string property is a null reference (Nothing in VB), then the corresponding Attribute will not be included in the request to the Print SCP. Similarly, if a numeric property is negative, the corresponding Attribute will not be included in the request. The Display Format ID must be specified in the passed object.

Example

For an example, refer to Associate.

Requirements

Target Platforms