L_SetCaptureOptionDlg

#include "l_bitmap.h"

L_LTSCR_API L_INT L_SetCaptureOptionDlg(hwndOwner, uFlags, pOptions, pfnCallBack, pUserData)

L_HWND hwndOwner;	/* handle of parent window */
L_UINT uFlags;	/* flags */
pLEADCAPTUREOPTION pOptions;	/* address of structure with options */
LTSCRHELPCB pfnCallBack;	/* optional help callback function */
L_VOID* pUserData;	/* pointer to more parameters for the help callback */

Brings up the capture option dialog box and sets the capture options.

Parameter	Description
hwndOwner	Handle of parent window.
uFlags	Flags that determine the options dialog. Possible values are:
	Value	Meaning
	NONE	[0x0000] No "?" help button will be shown.
	SCRDLG_SETCAPTUREOPTION_CONTEXTHELP	[0x0001] Capture options dialog context help. The "?" button will appear in the title bar if the pfnCallBack is not NULL.
pOptions	Address of a LEADCAPTUREOPTION structure that will be updated with the capture options entered through the dialog. You can pass NULL if you are not interested in the specified settings.
pfnCallBack	Optional help callback function for displaying help dialog. If you do not provide a help callback function, use NULL as the value of this parameter. If you do provide a help callback function, use the function pointer as the value of this parameter. The callback function must adhere to the function prototype described in LTSCRHELPCB Function.
pUserData	Void pointer that you can use to pass one or more additional parameters that the help 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

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

Comments

Use this function to change the current image capture options. For information on the default capture options, refer to LEADCAPTUREOPTION.

If a help callback function was provided in pfnCallback, a Help button will appear on the dialog. If NULL was provided, no Help button will appear.

Required DLLs and Libraries

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.

See Also

Functions:	L_SetCaptureOption, L_GetCaptureOption, LTSCRHELPCB Function
Topics:	Screen Capture API Function Groups: Setting Information Functions
	Implementing Screen Capture

Example

static L_INT EXT_CALLBACK pfnCallback (L_UINT32 uFlag, L_INT nCtlID, L_VOID* pUserData)
{
   UNREFERENCED_PARAMETER (uFlag);
   UNREFERENCED_PARAMETER (nCtlID);
   UNREFERENCED_PARAMETER (pUserData);
   /* save the captured image */
   MessageBox (NULL, TEXT("This is Help Dialog."), TEXT("Help"), MB_OK);
}
L_INT SetCaptureOptionDlgExample(L_VOID )
{
   LEADCAPTUREOPTION CaptureOption;
   HWND hWnd;
   /*To call the L_SetCaptureOptionDlg*/
   hWnd = GetForegroundWindow();
   CaptureOption.uStructSize = sizeof(LEADCAPTUREOPTION);
   /* retrieve a copy of CaptureOption */
   L_INT nRet = L_SetCaptureOptionDlg(hWnd, SCRDLG_SETCAPTUREOPTION_CONTEXTHELP, &CaptureOption, pfnCallback, NULL);
   return nRet;
}