L_DicomSetOverlayBitmap

#include "ltdic.h"

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

HDICOMDS hDS;	/* a DICOM handle */
L_UINT uOverlayIndex;	/* the overlay index */
pBITMAPHANDLE pBitmap;	/* pointer to the overlay bitmap handle */
L_UINT uFlags;	/* reserved for future use */

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

Parameter	Description
hDS	A DICOM handle.
uOverlayIndex	The index of the overlay being affected. This index is zero-based.
pBitmap	Pointer to a bitmap handle which will be used to update the overlay data. Cannot be NULL.
uFlags	Reserved for future use. Pass 0.

Returns

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 doesnt match the "Overlay Columns" (60xx, 0011) or if the bitmap height doesnt match the "Overlay Rows" (60xx, 0011) for the overlay being updated.

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:	L_DicomGetOverlayCount, L_DicomGetOverlayAttributes, L_DicomGetOverlayActivationLayer, L_DicomGetOverlayBitmap, L_DicomGetOverlayBitmapList, L_DicomSetOverlayAttributes, L_DicomSetOverlayBitmapList, L_DicomDeleteOverlay
Topics:	Overlays Overview
	Overlays

Example

For an example, refer to L_DicomSetOverlayAttributes.