In This Topic ▼

L_DicomLoadContextGroup

Summary

Loads the specified Context Group from the internal table into the Context Group Table.

Syntax

#include "ltdic.h"

L_LTDIC_API L_UINT16 L_DicomLoadContextGroup(pszContextID)

Parameters

L_TCHAR * pszContextID

Character string that contains the Context Identifier (CID) of the Context Group to be loaded from the internal table. For a list of possible values, refer to Context Identifier Values. If this parameter is set to NULL, the function loads all Context Groups that are currently unloaded.

Returns

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

Comments

A Context Group can be added to the Context Group Table either by loading it from the internal table maintained by LEADTOOLS or by inserting it directly into the Context Group Table. The Context Groups in the internal table are those defined by the DICOM Content Mapping Resource (DCMR). Use the L_DicomLoadContextGroup function to load the desired Context Groups from this table into the Context Group Table. Use the L_DicomInsertContextGroup function to insert a Context Group.

If the Context Group Table already contains a Context Group with the specified Context ID, the function will just return successfully. If the parameter pszContextID is set to NULL, the function will load all the Context Groups that are not currently loaded, without affecting any Context Group that is already in the Context Group Table. (Therefore, you can load all the Context Groups in the internal table from the beginning by setting the parameter pszContextID to NULL and calling the function.)

A return value of DICOM_ERROR_PARAMETER indicates that the internal table does not contain a Context Group with the specified Context ID.