LDicomIOD::SetDescription

#include "Ltdic.h"

static L_BOOL LDicomIOD::SetDescription(pIOD, pszDescription)

pDICOMIOD pIOD;

/* pointer to a DICOMIOD structure */

L_CHAR * pszDescription;

/* character string */

Sets the description of the specified item in the IOD Structure.

Parameter

Description

pIOD

Pointer to a structure that contains an item in the IOD Structure. The description of this item will be set using the string contained in pszDescription.

pszDescription

Character string that contains the description to be set.

Returns

TRUE

The description was successfully set.

FALSE

Not enough memory.

Comments

The following functions will also help you navigate the IOD Structure:

LDicomIOD::GetFirst

LDicomIOD::GetLast

LDicomIOD::GetNext

LDicomIOD::GetParent

LDicomIOD::GetChild

LDicomIOD::GetRoot

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:

LDicomIOD::GetFirst, LDicomIOD::GetLast, LDicomIOD::GetNext, LDicomIOD::GetPrev, LDicomIOD::GetCountModule, LDicomIOD::GetParent, LDicomIOD::GetChild, LDicomIOD::GetRoot

Topics:

Working with Information Object Definitions

Example

/* This example changes the module’s description */

L_VOID Test()
{
   pDICOMIOD pIOD;

   pIOD = LDicomIOD::FindModule(CLASS_US_IMAGE_STORAGE, MODULE_PATIENT_STUDY);
   if (pIOD != NULL)
   {
      LDicomIOD::SetDescription(pIOD, "New Description");
   }
}