L_INT LDicomPrintSCU::CreateOverlayBox(pOverlay, pParameters)
Requests the Print SCP to create a Basic Print Image Overlay Box SOP Instance.
Pointer to an LDicomDS object that contains the Overlay data for the Image Overlay Box to be created. The object is assumed to contain the Overlay Pixel Data Sequence (2040,0020). If this parameter is set to NULL or if the Sequence is not present, the function will return an error.
Pointer to an OVERLAYBOXPARAMETERS structure that specifies the parameters of the Image Overlay Box to be created. The function will return an error if this is set to NULL.
|0||The Basic Print Image Overlay Box 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||The Basic Print Image Overlay Box SOP Class is not supported on the Association.|
|> 0||An error occurred. Refer to Return Codes.|
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 CreateOverlayBox is 0, then the Image Overlay Box was created successfully, with either a Success or Warning status code in the response of the Print SCP.
The function can be used to create one or more Image Overlay Boxes. Having an Image Overlay Box created, the function LDicomPrintSCU::GetOverlayBoxInstanceUID can be used to obtain its SOP Instance UID, which in turn can be used to reference the Image Overlay Box from Image Boxes. Refer to the function LDicomPrintSCU::UpdateImageBox.
The parameter pParameters points to an OVERLAYBOXPARAMETERS structure that specifies the parameters to be used when creating the Image Overlay Box. The structure members nOverlayOriginRow and nOverlayOriginColumn will always be used to specify the Overlay Origin (6000,0050); these can be negative. If a string member of the structure is NULL, then the corresponding Attribute will not be included in the request to the Print SCP. Also, if the member nMagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request.
Required DLLs and Libraries
For an example, refer to LDicomPrintSCU::UpdateImageBox.
Medical Web Viewer .NET
.NET, Java, Android, and iOS/macOS Assemblies
C API/C++ Class Libraries