UpdateFilmBox Method

public void UpdateFilmBox( 
   DicomFilmBoxParameters parameters,
   string refPresentationLutInstanceUid
)

'Declaration
 
Public Sub UpdateFilmBox( _
   ByVal parameters As DicomFilmBoxParameters, _
   ByVal refPresentationLutInstanceUid As String _
) 

'Usage
 
Dim instance As DicomPrintScu
Dim parameters As DicomFilmBoxParameters
Dim refPresentationLutInstanceUid As String
 
instance.UpdateFilmBox(parameters, refPresentationLutInstanceUid)

public void UpdateFilmBox( 
   DicomFilmBoxParameters parameters,
   string refPresentationLutInstanceUid
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.UpdateFilmBox( 
   parameters ,
   refPresentationLutInstanceUid 
)

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

Parameters

parameters

A DicomFilmBoxParameters object that specifies the Film Box parameters to be updated. This can be set to a null reference (Nothing in Visual Basic) if none of the parameters specified by the DicomFilmBoxParameters class are to be updated; in this case, the request will be sent to the Print SCP without specifying any of them.

refPresentationLutInstanceUid

The SOP Instance UID of a previously created Presentation LUT SOP Instance to be referenced by the Film Box. This can be set to a null reference (Nothing in Visual Basic) if the reference is not to be updated; in this case, the corresponding Attribute will not be included in the request to the Print SCP. If an empty string is specified and the Film Box already references a Presentation LUT, then the update will remove that reference.

There must be a Film Box currently created before using this method.

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

The parameter parameters specifies the Film Box parameters to be updated. In the passed object, if a string property is a null reference (Nothing in Visual Basic), then the corresponding Attribute will not be included in the request to the Print SCP and hence will not be updated. Similarly, if a numeric property is negative, the corresponding Attribute will not be included in the request and hence will not be updated. Notice that not all the parameters that can be specified when creating the Film Box can be updated; the method will ignore the following properties of the DicomFilmBoxParameters class:

DicomFilmBoxParameters.ImageDisplayFormat

DicomFilmBoxParameters.FilmOrientation

DicomFilmBoxParameters.FilmSizeID

DicomFilmBoxParameters.AnnotationDisplayFormatID

DicomFilmBoxParameters.RequestedResolutionID

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomPrintScu Class
DicomPrintScu Members
CreateFilmBox Method
GetLastOperationStatus Method