LDicomDS::RemoveLayerByName

#include "Ltdic.h"

L_UINT16 LDicomDS::RemoveLayerByName(pszLayerName, bAnnSequence)

L_TCHAR* pszLayerName;

name of layer to be removed

L_BOOL bAnnSequence;

flag

Deletes all the elements that describe a layer.

Parameter Description
pszLayerName The name of the layer to be removed from the Graphic Layer Module.
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

0

SUCCESS

>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

See Also

Functions:

LDicomDS::GetLayerInfo, LDicomDS::SetLayerInfo, LDicomDS::RemoveLayerByIndex, LDicomDS::RemoveAllLayers, LDicomDS::GetLayerCount, LDicomDS::GetLayerIndex, LDicomDS::GetLayerGraphicObjectCount, LDicomDS::RemoveLayerGraphicObjects, LDicomDS::GetLayerTextObjectCount, LDicomDS::RemoveLayerTextObjects, LDicomDS::GetLayerElementByIndex, LDicomDS::GetLayerElementByName, Class Members

Topics:

Working with DICOM Annotations

 

How to Disable the Automatic Loading of the default DICOM IOD Table

Example

L_INT LDicomDS_RemoveLayerByNameExample(LDicomDS& PresStateDS, L_TCHAR* pszLayerName) 
{ 
   L_INT nRet; 
   nRet = PresStateDS.RemoveLayerByName(pszLayerName, true); 
   if (nRet == DICOM_SUCCESS) 
   { 
      MessageBox( NULL, 
      TEXT("Layer has been removed successfully."), 
      TEXT("Note"), 
      MB_OK); 
   } 
   return DICOM_SUCCESS; 
} 

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