LTCOMMDLGHELPCB

Summary

The callback function that will be called to provide the appropriate help information, based on the dialog from which help was requested.

Syntax

L_VOID pEXT_CALLBACK YourFunction(uFlag, nCtlID, pUserData)

Parameters

L_UINT32 uFlag

Identifies the origin of the help command message. Possible values are:

L_INT nCtlID

ID of the control that received the context sensitive help click. A value of -1 refers to the Help Button itself. For a list of other possible values, refer to the DLGRESID.H file in the LEAD \ INCLUDE directory.

L_VOID *pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of the calling function.)

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Comments

This callback function is optional. It is necessary only if you wish to provide help information for individual dialogs. The exact nature of the help provided is up to you, but must be outlined in this callback function. In order to implement help for a dialog box, a pointer to this HelpCallback Function must be passed to the specific dialog function. By passing this pointer, a Help button is shown in the dialog.

Returns

None.

Required DLLs and Libraries

• LTDLGIMGEFX
• LTDLGKRN
• LTDLGUTL
• LTDLGCTRL
• LTDLGCOM
• LTDIS
• LTIMG
• LTKRN
• 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

• OPENDLGFILELOADCALLBACK

Topics

• Dialogs: Callback Functions

Example

For an example, refer to L_DlgSetFont.