In This Topic ▼

LDicomPrintSCU::CreateFilmSession

Summary

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

Syntax

#include "ltdic.h"

L_INT LDicomPrintSCU::CreateFilmSession(pParameters, bColorPrintManagement = FALSE)

Parameters

const pFILMSESSIONPARAMETERS pParameters

Pointer to a FILMSESSIONPARAMETERS structure that specifies the parameters of the Film Session to be created. If this is set to NULL, then the request will be sent to the Print SCP without specifying any parameters (Attributes).

L_BOOL bColorPrintManagement

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:

Value	Meaning
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.
FALSE	The request will be to create an Instance of the Basic Film Session SOP Class of the Basic Grayscale Print Management Meta SOP Class.

Returns

Value	Meaning
0	The Basic Film Session SOP Instance was created successfully.
DICOM_ERROR_PRINTSCU_FAILURE_STATUS	The response of the Print SCP specifies a Failure status code; no Instance was created.
DICOM_ERROR_PRINTSCU_CLASS_NOT_SUPPORTED	Neither the Basic Grayscale Print Management Meta SOP Class nor the Basic Color Print Management Meta SOP Class is supported on the Association.
> 0	An error occurred. Refer to Return Codes.

Comments

Once a Film Session is created, the function LDicomPrintSCU::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 function will not return until it receives the response of the Print SCP, or an error occurs. The function LDicomPrintSCU::GetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. When the return value of the function CreateFilmSession is 0, then 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 function LDicomPrintSCU::GetFilmSessionInstanceUID can be used to obtain its SOP Instance UID. Also, the functions LDicomPrintSCU::UpdateFilmSession, LDicomPrintSCU::PrintFilmSession, and LDicomPrintSCU::DeleteFilmSession can be used to update, print, and delete the Film Session, respectively.

The parameter pParameters points to a FILMSESSIONPARAMETERS structure that specifies the parameters to be used when creating the Film Session. In this structure, if a string member is NULL, then the corresponding Attribute will not be included in the request to the Print SCP. Similarly, if a numeric member (that specifies an Attribute) is negative, the corresponding Attribute will not be included in the request. If pParameters is set to NULL, then the request will be sent without specifying any parameters.

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