L_DicomSetOverlayBitmap

Summary

Sets the "Overlay Data" (60xx,3000) for the specified overlay index.

Syntax

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomSetOverlayBitmap(hDS, uOverlayIndex, pBitmap, uFlags)

Parameters

HDICOMDS hDS

A DICOM handle.

L_UINT uOverlayIndex

The index of the overlay being affected. This index is zero-based.

pBITMAPHANDLE pBitmap

Pointer to a bitmap handle which will be used to update the overlay data. Cannot be NULL.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value Meaning
DICOM_SUCCESS The function was successful.
>0 An error occurred. Refer to Return Codes.

Comments

This function will update the stream of bytes under the "Overlay Data" (60xx, 3000) element with the data in the specified bitmap handle.

This function will fail if the bitmap width does not match the "Overlay Columns" (60xx, 0011) or if the bitmap height does not match the "Overlay Rows" (60xx, 0011) for the overlay being updated.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

For an example, refer to L_DicomSetOverlayAttributes.

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

LEADTOOLS DICOM C API Help
Introduction
Version History
Getting Started
Features of LEADTOOLS DICOM
Redistributables/Files To Be Included With Your Application
Quick Reference
Function References
Appendix

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.