Help Version 19.0.2017.10.27
References ▼
#include "ltivw.h"
L_LTIVW_API L_INT L_DispContainerSetBuiltInTagCallBack(hCellWnd, pBuiltInTagCallBack, pUserData);
L_HWND hCellWnd; |
handle to the cell window |
DISPCONTAINERBUILTINTAGCALLBACK pBuiltInTagCallBack; |
callback function |
L_VOID * pUserData; |
pointer to more parameters for the callback |
Sets a callback function, which lets the user handle and update the built-in tags.
Parameter |
Description |
| hCellWnd | A handle to the window that represents the Medical Viewer Cell. |
| pBuiltInTagCallBack | Callback function that is called every time the built-in tag is about to be drawn. The callback function must adhere to the function prototype described in DISPCONTAINERBUILTINTAGCALLBACK. |
| 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. |
| SUCCESS | The function was successful. |
| 1 | An error occurred. Refer to Return Codes. |
To get the current callback function used to handle the built-in tag, call L_DispContainerGetBuiltInTagCallBack.
The built-in tag is an overlay text that gets updated automatically once the image changes its correspondent property.
To add a tag to the medical viewer, use the function L_DispContainerSetCellTag.
Required DLLs and Libraries
| LTIVW For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
For an example, refer to L_DispContainerGetBuiltInTagCallBack.