LScreenCapture::ScreenCaptureHelpCallBack

#include "ltwrappr.h"

virtual L_VOID LScreenCapture::ScreenCaptureHelpCallBack(uFlag, nCtlID, pUserData)

L_UINT32 uFlag;	/* flag indicating the origin of the help command message */
L_INT nCtlID;	/* control ID */
L_VOID L_FAR* pUserData;	/* pointer to additional parameters */

Provides the appropriate help information, based on the dialog from which help was requested.

Parameter	Description
uFlag	Flag that identifies the origin of the help command message. Possible values are:
	Value	Meaning
	SCRDLG_HELP_SETCAPTUREOPTION	[1] Help command message is coming from LScreenCapture::SetCaptureOptionDlg.
	SCRDLG_HELP_CAPTUREAREAOPTION	[2] Help command message is coming from LScreenCapture::CaptureAreaOptionDlg.
	SCRDLG_HELP_CAPTUREOBJECTOPTION	[3] Help command message is coming from LScreenCapture::CaptureObjectOptionDlg.
	SCRDLG_HELP_CAPTUREFROMEXE	[4] Help command message is coming from LScreenCapture::CaptureFromExeDlg.
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 LTSCR.H file in the LEAD\INCLUDE directory.
pUserData	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.

Returns

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

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 you must override this function in order to provide that help. In addition, you must call LBase::EnableCallBack before calling any function that uses this callback.

This callback function is used with the following methods:

LScreenCapture::CaptureAreaOptionDlg

LScreenCapture::CaptureFromEXEDlg

LScreenCapture::CaptureObjectOptionDlg

LScreenCapture::SetCaptureOptionDlg

Required DLLs and Libraries

LTDIS
LTSCR

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.