LDicomDS::SetDebugDS

#include "Ltdic.h"

L_VOID LDicomDS::SetDebugDS(pfnCallback, pUserData)

CONFORMANCECALLBACK pfnCallback;	/* pointer to a callback function */
L_VOID * pUserData;	/* pointer to additional parameters */

This function is for debugging purposes.

Parameter	Description
pfnCallback	Optional callback function. If you do not provide a callback function, use NULL as the value of this parameter. If you do provide a callback function, use the function pointer as the value of this parameter. The callback function must adhere to the function prototype described in CONFORMANCECALLBACK Function.
pUserData	Void pointer that you can use to pass one or more additional parameters that the callback function needs.
	To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_VOID *. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure.
	If the additional parameters are not needed, you can pass NULL in this parameter.

Returns

None.

Comments

The DICOM toolkit offers extensive debugging and status information by optionally notifying the user of each internal error that occurs. To enable this feature call the function LDicomDS::SetDebugDS to specify the callback function which will be called each time the user needs to be notified. This feature is disabled by default.

When you access an invalid element, then the callback function will be called to notify you of the error. This may be seen when calling LDicomDS::GetCountImage in the example below. For any error that is found, nFlags should be set with the appropriate error and False returned from the callback function.

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

See Also

Functions:	CONFORMANCECALLBACK
Topics:	Working with Data Sets
	How to Disable the Automatic Loading of the default DICOM IOD Table

Example

L_BOOL DebugCallback (pDICOMELEMENT pElement, L_UINT16 nFlags, L_VOID *pUserData)
{
   UNREFERENCED_PARAMETER(pElement);
   HWND hWnd = (HWND)pUserData;
   if(nFlags == CALLBACK_ERROR_ELEMENT)
      MessageBox(hWnd, TEXT("You accessed an invalid element"), TEXT("Debug"), MB_OK);
   return TRUE;
}
L_INT LDicomDS_SetDebugDSExample(HWND hWnd)
{
   LDicomDS       DS;
   L_UINT32       lCount;
   pDICOMELEMENT  pElement=(pDICOMELEMENT)0x1234; /* init the element to a bad value */ 
   DS.InitDS( CLASS_CR_IMAGE_STORAGE, 0); 
   /* set the debug callback */
   DS.SetDebugDS((CONFORMANCECALLBACK)DebugCallback, (L_VOID *)hWnd); 
   /* to access the invalid element */
   lCount = DS.GetCountImage(pElement);
   return DICOM_SUCCESS;
}