L_DicomRemoveTextObject

#include "l_bitmap.h"

L_LTDIC_API L_UINT16 L_DicomRemoveTextObject(hDS, pGraphicAnnSQItem, uTextObjIndex)

HDICOMDS hDS;

/* a DICOM handle */

pDICOMELEMENT pGraphicAnnSQItem;

/* pointer to a DICOMELEMENT structure */

L_UINT uTextObjIndex;

/* text object index */

Removes the text annotation object at the specified index.

Parameter

Description

hDS

A DICOM handle.

pGraphicAnnSQItem

Pointer to an item element under the "Graphic Annotation Sequence" (0008,1115) in the "Graphic Annotation Module".

uTextObjIndex

Zero-based index of the text annotation object to be removed.

Returns

DICOM_SUCCESS

The function was successful.

>0

An error occurred. Refer to Return Codes.

Comments

This function will remove the text annotation object at the specified index in the specified "Graphic Annotation Sequence" (0070,0001) item.The index is zero-based.

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:

L_DicomFindFirstGraphicAnnSQItem, L_DicomCreateGraphicAnnSQItem, L_DicomCreateTextObject, L_DicomGetTextObjectInfo, L_DicomSetTextObjectInfo, L_DicomGetTextObjectCount, L_DicomRemoveAllTextObjects, L_DicomGetTextObjElement, L_DicomConvertLEADAnnObjToDicomAnnObjs, L_DicomConvertDicomAnnObjToLEADAnnObj

Topics:

Working with DICOM Annotations

 

Dicom Annotations: Text Objects

Example

L_INT DicomRemoveTextObjectExample(HDICOMDS hPresStateDS)
{
   pDICOMELEMENT pGraphicAnnSQItem = L_DicomFindFirstGraphicAnnSQItem(hPresStateDS);
   L_UINT16 nRet = L_DicomRemoveTextObject (hPresStateDS,pGraphicAnnSQItem, 0);
   if (nRet == DICOM_SUCCESS)
   {
      MessageBox( NULL, 
                  TEXT("Textual Object has been successfully removed!"), 
                  TEXT("Note"), 
                  MB_OK); 
   }
   return nRet;
}