L_DicomFindIOD

Show in webframe

#include "Ltdic.h"

L_LTDIC_API pDICOMIOD L_DicomFindIOD(pIOD, nCode, nType, bTree)

pDICOMIOD pIOD;	/* pointer to a DICOMIOD structure */
L_UINT32 nCode;	/* code */
L_UCHAR nType;	/* type */
L_BOOL bTree;	/* flag that indicates how to evaluate the IOD structure */

Returns a pointer to an item in the IOD Structure that contains the IOD with the specified code and type.

Parameter	Description
pIOD	Pointer to a DICOMIOD structure that contains an item in the IOD Structure. A pointer to the item in the IOD Structure that contains the IOD with the specified nCode and nType will be returned.
nCode	Code value that specifies the Information Object Definition. The information object may be a Class, a Module or a Tag. For lists of default values, refer to Data Element Tag Constants, IOD Class Constants, and IOD Module Constants.
nType	The type of Information Object Definition you are working with. Possible values are:
	Value	Meaning
	IOD_TYPE_CLASS	[0x00] Class type Information Object Definition.
	IOD_TYPE_MODULE	[0x01] Module type Information Object Definition.
	IOD_TYPE_ELEMENT	[0x02] Element type Information Object Definition.

bTree	Flag that indicates how the IOD Structure will be evaluated. Possible values are:
	Value	Meaning
	TRUE	Evaluate the IOD Structure as a tree.
	FALSE	Evaluate the IOD Structure as a list.

Returns

!NULL	A pointer to a DICOMIOD structure that contains the item in the IOD Structure of the specified code and type.
NULL	An item with the specified code and type was not found.

Comments

The nCode and nType parameters must correspond. For example, if you specify IOD_TYPE_CLASS in nType, you must specify a value from the IOD Class Constants in nCode. If you specify some other value, the item will not be found in the IOD Structure.

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.

See Also

Functions:	L_DicomFindClassIOD, L_DicomFindModuleIOD, L_DicomFindIndexModuleIOD, L_DicomLoadXmlIOD
Topics:	Working with Information Object Definitions
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

This example displays the name of an item

L_INT DicomFindIODExample(L_VOID)
{
   pDICOMIOD pIOD;

   pIOD = L_DicomFindIOD(NULL, TAG_PATIENT_NAME, IOD_TYPE_ELEMENT, FALSE);
   if (pIOD != NULL)
      MessageBox(NULL, pIOD->pszName, TEXT("Notice"), MB_OK);

   return DICOM_SUCCESS;
}