L_DicomPrintSCUCreateFilmBox

#include "ltdic.h"

L_LTDIC_API L_INT L_DicomPrintSCUCreateFilmBox(hPrintSCU, pParameters, pszRefPresLUTInstanceUID)

HDICOMPRINTSCU hPrintSCU; A handle for Dicom Print SCU.
const pFILMBOXPARAMETERS pParameters; Film Box parameters.
const L_TCHAR *pszRefPresLUTInstanceUID; Referenced Presentation LUT.

Parameter Description
hPrintSCU A handle for Dicom Print SCU.
pParameters Film Box parameters.
pszRefPresLUTInstanceUID Referenced Presentation LUT

Returns

SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

A Film Session must have been created before creating Film Boxes.

The function will not return until it receives the response of the Print SCP, or an error occurs. The function L_DicomPrintSCUGetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. When the return value of the function CreateFilmBox is 0, then 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 function L_DicomPrintSCUGetFilmBoxInstanceUID can be used to obtain its SOP Instance UID. Also, the functions L_DicomPrintSCUUpdateFilmBox, L_DicomPrintSCUPrintFilmBox, and L_DicomPrintSCUDeleteFilmBox 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 FILMBOXPARAMETERS structure. An array of the SOP Instance UIDs of these Image Boxes is kept internally. The following functions can be used to handle the Image Boxes:

Similarly, when a Film Box is created, and if the pFILMBOXPARAMETERS structure 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 functions can be used to handle the Annotation Boxes:

The function 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 pParameters points to a pFILMBOXPARAMETERS structure that specifies the parameters to be used when creating the Film Box. 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. The Display Format ID must be specified in this structure.

Required DLLs and Libraries

LTDIC
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64, Linux.

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

LEADTOOLS DICOM C API Help