L_DispContainerSetBuiltInTagCallBack

Summary

Sets a callback function, which lets the user handle and update the built-in tags.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetBuiltInTagCallBack(hCellWnd, pBuiltInTagCallBack, pUserData);

Parameters

L_HWND hCellWnd

A handle to the window that represents the Medical Viewer Cell.

DISPCONTAINERBUILTINTAGCALLBACK 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.

L_VOID * 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

Value Meaning
SUCCESS The function was successful.
1 An error occurred. Refer to Return Codes.

Comments

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

See Also

Functions

Topics

Example

For an example, refer to L_DispContainerGetBuiltInTagCallBack.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C API Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.