L_DicomSetOverlayBitmapList

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomSetOverlayBitmapList(hDS, uOverlayIndex, hList, uFlags)

HDICOMDS hDS;

a DICOM handle

L_UINT uOverlayIndex;

the overlay 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

hDS

A DICOM handle.

uOverlayIndex

The index of the overlay for which to set the bitmap list. This index is zero-based.

hList

Handle to the list of bitmaps.

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 of the bitmaps included in a bitmap list.

Before calling this function you must call L_DicomSetOverlayAttributes to set the attributes of the bitmap you are trying to update. Make sure that the number of bitmaps in the list doesnt 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, Linux.

See Also

Functions:

L_DicomGetOverlayCount, L_DicomGetOverlayAttributes, L_DicomGetOverlayActivationLayer, L_DicomGetOverlayBitmap, L_DicomGetOverlayBitmapList, L_DicomSetOverlayAttributes, L_DicomSetOverlayBitmap, L_DicomDeleteOverlay

Topics:

Overlays Overview

 

Overlays

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT DicomSetOverlayBitmapListExample(HBITMAPLIST hList) 
{ 
   HDICOMDS hDS; 
   L_UINT16 uRet; 
   hDS = L_DicomCreateDS(NULL); 
   uRet = L_DicomLoadDS(hDS, MAKE_IMAGE_PATH(TEXT("Image1.dcm")), 0); 
   if (uRet != DICOM_SUCCESS) 
   { 
      L_DicomFreeDS(hDS); 
      return uRet; 
   } 
   uRet = L_DicomSetOverlayBitmapList(hDS,0, hList, 0); 
   L_DicomFreeDS(hDS); 
   return uRet; 
} 

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS DICOM C API Help