L_CaptureObjectOptionDlg
#include "l_bitmap.h"
L_INT EXT_FUNCTION L_CaptureObjectOptionDlg(hParentWnd, uFlags, pObjectOptions, nUseDefault, pfnCallBack, pUserData)
|
HWND hParentWnd; |
/* handle to the parent window */ |
|
L_UINT uFlags; |
/* flags */ |
|
pLEADCAPTUREOBJECTOPTION pObjectOptions; |
/* pointer to the object option structure */ |
|
L_INT nUseDefault; |
/* flag */ |
|
LTSCRHELPCB pfnCallBack; |
/* optional help callback function */ |
|
L_VOID * pUserData; |
/* pointer to more parameters for the help callback */ |
Displays a dialog to retrieve the options for the L_CaptureSelectedObject function.
|
Parameter |
Description |
|
|
hParentWnd |
Handle to the parent window. |
|
|
uFlags |
Flags that determine whether to show the "?" button in the title bar the of the Capture Selected Object Options dialog. Possible values are: |
|
|
|
Value |
Meaning |
|
|
NONE |
[0x0000] No "?" help button will be shown. |
|
|
SCRDLG_CAPTUREOBJECTOPTION_CONTEXTHELP |
0x0004] The "?" button will appear in the title bar if the pfnCallBack is not NULL. |
|
pObjectOptions |
Pointer to a LEADCAPTUREOBJECTOPTION structure that contains information about capturing an object. |
|
|
nUseDefault |
If TRUE, the dialog will start with default values. Otherwise the dialog will use the values specified by the pLEADCAPTUREOBJECTOPTION structure. These values must be a valid values or the dialog will return an error code. |
|
|
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
This function will display the common dialog for setting the options for the L_CaptureSelectedObject function. The options selected by the user will be passed to the pObjectOptions parameter.
If a help callback function was provided in pfnCallback parameter, a Help button will appear on the dialog. If NULL was provided, the Help button will not 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. |
Platforms
Windows 95 / 98 / Me, Windows 2000 / XP, Windows CE.
See Also
|
Functions: |
L_CaptureSelectedObject, L_GetDefaultObjectOption, LTSCRHELPCB |
|
Topics: |
|
|
|
Example
L_INT CaptureObjectOptionDlgExample(L_VOID)
{
LEADCAPTUREOBJECTOPTION CaptureObjectOption;
HWND hWnd;
/* To call the L_CaptureObjectOptionDlg */
hWnd = GetForegroundWindow();
CaptureObjectOption.uStructSize = sizeof(LEADCAPTUREOBJECTOPTION);
/* use the defaults*/
L_INT nRet = L_CaptureObjectOptionDlg
(hWnd, 0, &CaptureObjectOption, TRUE, NULL, NULL);
return nRet;
}