In This Topic ▼

L_DicomRemoveLayerByName

Summary

Deletes all the elements that describe a layer.

Syntax

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomRemoveLayerByName(hDS, pszLayerName, bAnnSequence)

Parameters

HDICOMDS hDS

A DICOM handle.

L_TCHAR* pszLayerName

The name of the layer to be removed from the Graphic Layer Module.

L_BOOL bAnnSequence

Boolean flag which indicates whether to remove the items under the "Graphic Annotation Sequence" which correspond to this layer. Possible values are:

Value	Meaning
TRUE	Remove the items under the "Graphic Annotation Sequence" which correspond to this layer.
FALSE	Only remove the layer.

Returns

Value	Meaning
DICOM_SUCCESS	The function was successful.
>0	An error occurred. Refer to Return Codes.

Comments

This function removes the item, which represents a layer under the "Graphic Layer Sequence"(0070,0060).

If the bAnnSequence parameter is set to TRUE then the function will clean any elements under the "Graphic Annotation Sequence" which correspond to the layer being removed.

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.

Example

L_INT DicomRemoveLayerByNameExample(HDICOMDS hPresStateDS, L_TCHAR* pszLayerName) 
{ 
 L_UINT16 nRet = L_DicomRemoveLayerByName ( hPresStateDS, 
                                             pszLayerName, 
                                             TRUE); 
   if (nRet == DICOM_SUCCESS) 
   { 
      MessageBox( NULL,  
                  TEXT("Layer has been removed successfully."),  
                  TEXT("Note"),  
                  MB_OK); 
   } 
   return nRet; 
}