LDicomDS::GetLayerInfo

#include "Ltdic.h"

L_UINT16 LDicomDS::GetLayerInfo(uLayerIndex, pGraphicLayer, uStructSize)

L_UINT uLayerIndex;	/* zero-based index of the layer */
pDICOMGRAPHICLAYER pGraphicLayer;	/* pointer to a DICOMGRAPHICLAYER structure */
L_UINT uStructSize;	/* the size of the DICOMGRAPHICLAYER structure */

Retrieves the attributes of a layer at the specified index.

Parameter	Description
uLayerIndex	Zero-based index of the layer whose attributes are to be retrieved.
pGraphicLayer	Pointer to a structure which will be filled with the layer attributes.
uStructSize	Size of the DICOMGRAPHICLAYER structure. Pass sizeof(DICOMGRAPHICLAYER).

Returns

0	SUCCESS
>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

See Also

Functions:	LDicomDS::SetLayerInfo, LDicomDS::RemoveLayerByIndex, LDicomDS::RemoveLayerByName, 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

Example

L_INT LDicomDS_GetLayerInfoExample(LDicomDS& PresStateDS, L_UINT uLayerIndex) 
{
   L_INT             nRet;
   DICOMGRAPHICLAYER Layer; 
   L_TCHAR           szText[256] = TEXT(""); 
   memset(&Layer, 0, sizeof(DICOMGRAPHICLAYER)); 
   nRet = PresStateDS.GetLayerInfo(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;
}