LEADTOOLS DICOM C DLL Help
| LEADTOOLS DICOM C DLL Help > Function References > L_DicomDeleteOverlay |
#include "ltdic.h"
L_LTDIC_API L_UINT16 L_DicomDeleteOverlay(hDS, uOverlayIndex, uFlags)
|
HDICOMDS hDS; |
/* a DICOM handle */ |
|
L_UINT uOverlayIndex; |
/* the overlay index */ |
|
L_UINT uFlags; |
/* reserved for future use */ |
Deletes all the elements that describe an overlay.
|
Parameter |
Description |
|
hDS |
A DICOM handle. |
|
uOverlayIndex |
The index of the overlay being deleted. This index is zero-based. |
|
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 delete the following elements:
|
"Overlay Rows" |
(60xx, 0010) |
|
"Overlay Columns" |
(60xx, 0011) |
|
"Overlay Planes" |
(60xx, 0012) |
|
"Number of Frames in Overlay" |
(60xx, 0015) |
|
"Overlay Description" |
(60xx, 0022) |
|
"Overlay Type" |
(60xx, 0040) |
|
"Overlay Subtype" |
(60xx, 0045) |
|
"Overlay Origin" |
(60xx, 0050) |
|
"Image Frame Origin" |
(60xx, 0051) |
|
"Overlay Plane Origin" |
(60xx, 0052) |
|
"Overlay Bits Allocated" |
(60xx, 0100) |
|
"Overlay Bit Position" |
(60xx, 0102) |
|
"Overlay Activation Layer" |
(60xx, 1001) |
|
"ROI Area" |
(60xx, 1301) |
|
"ROI Mean" |
(60xx, 1302) |
|
"ROI Standard Deviation" |
(60xx, 1303) |
|
"Overlay Label" |
(60xx, 1500) |
|
"Overlay Data" |
(60xx, 3000) |
Required DLLs and Libraries
|
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application |
Win32, x64, Linux.
See Also
Example
For an example, refer to L_DicomSetOverlayAttributes.
