UpdateFilmSession Method

Summary

Requests the Print SCP to update the current Basic Film Session SOP Instance.

Syntax

C++

public void UpdateFilmSession( 
   DicomFilmSessionParameters parameters 
)

Public Sub UpdateFilmSession( _ 
   ByVal parameters As DicomFilmSessionParameters _ 
)

public: 
void UpdateFilmSession(  
   DicomFilmSessionParameters^ parameters 
)

Parameters

parameters
A DicomFilmSessionParameters object that specifies the Film Session parameters to be updated. The method will fail if this is set to a null reference (Nothing in VB).

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.
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.

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

The parameter parameters specifies the Film Session parameters to be updated. 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 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. The method will fail if parameters is set to a null reference or if all string properties are set to null references and all numeric properties are negative.

Example

For an example, refer to Associate.

Requirements

Target Platforms