LDicomDS::SetOverlayBitmapList

#include "ltdic.h"

L_UINT16 LDicomDS::SetOverlayBitmapList(uOverlayIndex, hList, uFlags)

L_UINT uOverlayIndex;	/* index */
HBITMAPLIST hList;	/* handle to the list of bitmaps */
L_UINT uFlags;	/* reserved for future use */

Sets the "Overlay Data" (60xx,3000) for the specified overlay index from a list of bitmaps.

Parameter	Description
uOverlayIndex	The index of the overlay for which to set the bitmap list.
hList	Handle to the list of bitmaps.
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 of the bitmaps included in a bitmap list.

Before calling this function you must call LDicomDS::SetOverlayAttributes to set the attributes of the bitmap you are trying to update. Make sure that the number of bitmaps in the list does not exceed the value of the "Number of Frames in Overlay" (60xx,0015) element.

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::SetOverlayBitmap, LDicomDS::DeleteOverlay
Topics:	Overlays Overview
	Overlays
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName
L_INT LDicomDS_SetOverlayBitmapListExample(HBITMAPLIST hList) 
{
   L_INT          nRet;
   LDicomDS      *pDS;  
   pDS = new LDicomDS(NULL); 
   nRet = pDS->LoadDS(MAKE_IMAGE_PATH(TEXT("image1.dcm")), 0); 
   if(nRet != DICOM_SUCCESS)
      return nRet;
   pDS->SetOverlayBitmapList(0, hList, 0); 
   delete pDS; 
   return DICOM_SUCCESS;
}