←Select platform

CreateFilmSession Method

Summary

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

Syntax
C#
VB
C++
public void CreateFilmSession( 
   DicomFilmSessionParameters parameters, 
   bool colorPrintManagement 
) 
Public Sub CreateFilmSession( _ 
   ByVal parameters As DicomFilmSessionParameters, _ 
   ByVal colorPrintManagement As Boolean _ 
)  
public: 
void CreateFilmSession(  
   DicomFilmSessionParameters^ parameters, 
   bool colorPrintManagement 
)  

Parameters

parameters
A DicomFilmSessionParameters object that specifies the parameters of the Film Session to be created. If this is set to a null reference (Nothing in VB), then the request will be sent to the Print SCP without specifying any parameters (Attributes).

colorPrintManagement
If either the Basic Grayscale Print Management Meta SOP Class or the Basic Color Print Management Meta SOP Class (but not both) is supported on the Association, then this parameter will be ignored and the request will be to create an Instance of the Basic Film Session SOP Class of the Meta SOP Class supported. If both Meta SOP Classes are supported then: If colorPrintManagement is true, the request will be to create an Instance of the Basic Film Session SOP Class of the Basic Color Print Management Meta SOP Class; otherwise, the request will be to create an Instance of the Basic Film Session SOP Class of the Basic Grayscale Print Management Meta SOP Class.

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.

Once a Film Session is created, the method CreateFilmBox can then be used to create one or more Film Boxes in the new Film Session. Notice that only one Film Session can be handled on the Association at any time.

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 CreateFilmSession is successful, the Film Session was created successfully, with either a Success or Warning status code in the response of the Print SCP.

Having the Film Session created, the method GetFilmSessionInstanceUid can be used to obtain its SOP Instance UID. Also, the methods UpdateFilmSession, PrintFilmSession, and DeleteFilmSession can be used to update, print, and delete the Film Session, respectively.

The parameter parameters specifies the parameters to be used when creating the Film Session. 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. If parameters is set to a null reference, then the request will be sent without specifying any parameters.

All the rest of the basic Print Management methods will adopt the Meta SOP Class of the created Basic Film Session SOP Instance.

Example

For an example, refer to Associate.

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Dicom Assembly