L_DicomGetTextObjectInfo

#include "l_bitmap.h"

L_LTDIC_API L_UINT16 L_DicomGetTextObjectInfo(hDS, pGraphicAnnSQItem, uTextObjectIndex, pTextObject, uStructSize)

HDICOMDS hDS;

/* a DICOM handle */

pDICOMELEMENT pGraphicAnnSQItem;

/* pointer to a DICOMELEMENT structure */

L_UINT uTextObjectIndex;

/* text annotation object index */

pDICOMTEXTOBJECT pTextObject;

/* pointer to the text annotation object attributes structure to be updated */

L_UINT uStructSize;

/* the size of the DICOMTEXTOBJECT structure - pass sizeof(DICOMTEXTOBJECT) */

Gets the attributes of a text annotation object.

Parameter

Description

hDS

A DICOM handle.

pGraphicAnnSQItem

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

uTextObjectIndex

The index of the text annotation object whose attributes we want to retrieve.

pTextObject

Pointer to a structure which will be filled with the text annotation object attributes.

uStructSize

Size of the DICOMTEXTOBJECT structure. Pass sizeof(DICOMTEXTOBJECT).

Returns

DICOM_SUCCESS

The function was successful.

>0

An error occurred. Refer to Return Codes.

Comments

This function will retrieve the attributes of a text object and store their values in the structure pointed to by pTextObject. pTextObject->uStructSize will be set to the value of the parameter uStructSize.

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_DicomRemoveTextObject, L_DicomSetTextObjectInfo, L_DicomGetTextObjectCount, L_DicomRemoveAllTextObjects, L_DicomGetTextObjElement, L_DicomConvertLEADAnnObjToDicomAnnObjs, L_DicomConvertDicomAnnObjToLEADAnnObj

Topics:

Working with DICOM Annotations

 

Dicom Annotations: Text Objects

Example

L_INT DicomGetTextObjectInfoExample(HDICOMDS hPresStateDS)
{
   L_TCHAR szText[256] = TEXT("\0");
   L_UINT16 nRet;
   DICOMTEXTOBJECT AnnTextual;
   L_UINT uObjsCount;
   L_UINT i;
   pDICOMELEMENT pGraphicAnnSQItem = L_DicomFindFirstGraphicAnnSQItem(hPresStateDS);
   memset(&AnnTextual, 0, sizeof(DICOMTEXTOBJECT));
   nRet = L_DicomGetLayerTextObjectCount( hPresStateDS,
                                          pGraphicAnnSQItem, 
                                          &uObjsCount);
   if (nRet != DICOM_SUCCESS)
      return nRet;
   if (uObjsCount > 0)
   {
      for (i = 0; i < uObjsCount; i++)
      {
         nRet = L_DicomGetTextObjectInfo( hPresStateDS,
                                          pGraphicAnnSQItem, 
                                          i, 
                                          &AnnTextual, 
                                          sizeof(DICOMTEXTOBJECT));
         if (nRet == DICOM_SUCCESS)
         {
            if (AnnTextual.pszTextValue)
            {
               wsprintf(szText, TEXT("Annotation text is: %s "), AnnTextual.pszTextValue);
               MessageBox( NULL, 
                           szText, 
                           TEXT("Note"), 
                           MB_OK); 
            }
         }
      }
   }
   return nRet;
}