LDicomPrintSCU::UpdateFilmBox

Summary

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

Syntax

L_INT LDicomPrintSCU::UpdateFilmBox(pParameters, pszRefPresLUTInstanceUID = NULL)

Parameters

const pFILMBOXPARAMETERS pParameters

Pointer to a FILMBOXPARAMETERS structure that specifies the Film Box parameters to be updated. This can be set to NULL if none of the structure parameters are to be updated. In this case, the request will be sent to the Print SCP without specifying any of them.

const L_TCHAR * pszRefPresLUTInstanceUID

Character string that contains the SOP Instance UID of a previously created Presentation LUT SOP Instance to be referenced by the Film Box. This can be set to NULL 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.

The function will return an error if both parameters are set to NULL.

Returns

Comments

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

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

The parameter pParameters points to a FILMBOXPARAMETERS structure that specifies the Film Box parameters to be updated. In this structure, if a string member is NULL, 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 member (that specifies an Attribute) 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 function will ignore the following members of the structure:

pszImageDisplayFormat

pszFilmOrientation

pszFilmSizeID

pszAnnotationDisplayFormatID

pszRequestedResolutionID

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

See Also

Functions

• Class Members
• LDicomPrintSCU::CreateFilmBox
• LDicomPrintSCU::GetLastOperationStatus

Topics

• Print Management SCU
• DICOM Print Management Service Class User: Functions

Example

For an example, refer to LDicomPrintSCU::UpdateImageBox.