In This Topic ▼

L_DicomGetLayerInfo

Summary

Retrieves the attributes of a layer at the specified index.

Syntax

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomGetLayerInfo(hDS, uLayerIndex, pGraphicLayer, uStructSize)

Parameters

HDICOMDS hDS

A DICOM handle.

L_UINT uLayerIndex

Zero-based index of the layer whose attributes are to be retrieved.

pDICOMGRAPHICLAYER pGraphicLayer

Pointer to a structure which will be filled with the layer attributes.

L_UINT uStructSize

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

Returns

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

Comments

This function will retrieve the attributes of a layer and store their values in the structure pointed to by pGraphicLayer.

pGraphicLayer->uStructSize will be set to the value of the parameter uStructSize.

The members of the structure pGraphicLayer are based on the "Graphic Layer Module Attributes" in the DICOM standard.

The index(uLayerIndex) is based on the number of items under the "Graphic Layer Sequence" (0070,0060), for example the index of the first item is zero.

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 DicomGetLayerInfoExample(HDICOMDS hPresStateDS, L_UINT uLayerIndex) 
{ 
   DICOMGRAPHICLAYER Layer; 
   L_UINT16 nRet;   
   L_TCHAR szText[256] = TEXT("\0"); 
 
   memset(&Layer, 0, sizeof(DICOMGRAPHICLAYER)); 
   nRet  = L_DicomGetLayerInfo(  hPresStateDS, 
                                 uLayerIndex,  
                                 &Layer,  
                                 sizeof(DICOMGRAPHICLAYER)); 
   if (nRet == DICOM_SUCCESS) 
   { 
      wsprintf(szText, TEXT("Layer Name is: %s"), Layer.pszLayerName); 
      MessageBox( NULL,  
                  szText,  
                  TEXT("Note"),  
                  MB_OK); 
   }  
   return nRet; 
}