LDicomDS::SetOverlayBitmap

Show in webframe

#include "ltdic.h"

L_UINT16 LDicomDS::SetOverlayBitmap (uOverlayIndex,pBitmap,uFlags)

L_UINT uOverlayIndex;	/* index */
pBITMAPHANDLE pBitmap;	/* pointer to a handle */
L_UINT uFlags;	/* reserved for future use */

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

Parameter	Description
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

0	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

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:	LDicomDS::GetOverlayCount, LDicomDS::GetOverlayAttributes, LDicomDS::GetOverlayActivationLayer, LDicomDS::GetOverlayBitmap, LDicomDS::GetOverlayBitmapList, LDicomDS::SetOverlayAttributes, LDicomDS::SetOverlayBitmapList, LDicomDS::DeleteOverlay
Topics:	Overlays Overview
	Overlays
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

For an example, refer to LDicomDS::SetOverlayAttributes.