L_DicomSetOverlayBitmapList

#include "ltdic.h"

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

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

Parameters

HDICOMDS hDS

A DICOM handle.

L_UINT uOverlayIndex

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

HBITMAPLIST hList

Handle to the list of bitmaps.

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 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 does not exceed the value of the "Number of Frames in Overlay" (60xx,0015) element.

Required DLLs and Libraries

Platforms

Win32, x64, Linux.

See Also

Functions

Topics

Example

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 20.0.2020.6.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 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