AVERAGEDLGPARAMS

typedef struct _AVERAGEDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   L_UINT uDim; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID *pHelpCallBackUserData; 
} AVERAGEDLGPARAMS,* LPAVERAGEDLGPARAMS; 

The AVERAGEDLGPARAMS structure provides information used to initialize the dialog box created by the L_DlgAverage function. After the user closes the dialog box, this structure is updated with information about the user's selections.

Members

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

pBitmap

Pointer to the bitmap handle that references the bitmap used for preview or processing.

bZoomToFit

Flag that indicates the initial zoom level for previewing the image. Possible values are:

Value Meaning
TRUE Set the initial zoom level to "Zoom to fit".
FALSE Set the initial zoom level to "Normal (1:1)".

uDim

Size of the averaging neighborhood. It is the length, in pixels, of one side of a square. The size ranges from 3 to 255.

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

Value Meaning
DLG_AVERAGE_AUTOPROCESS [0x00000001] process the image on OK. The pBitmap member of this structure should contain a valid bitmap.
DLG_AVERAGE_SHOW_CONTEXTHELP [0x00000002] dialog should contain a context sensitive help icon.
DLG_AVERAGE_SHOW_PREVIEW [0x00000004] show a preview of the image in the dialog. The pBitmap member of this structure should contain a valid bitmap.
DLG_AVERAGE_SHOW_TOOL_ZOOMLEVEL [0x00000008] show the "Zoom to fit" and "Zoom Normal" toolbar buttons. The DLG_AVERAGE_SHOW_PREVIEW flag must be set in order to show these buttons.

pfnHelpCallback

Pointer to an optional help callback function. If you do not wish to provide help to this dialog, use NULL as the value of this parameter. To provide help to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in LTCOMMDLGHELPCB.

pHelpCallBackUserData

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

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

LEADTOOLS Common Dialog C API Help