Member

Description

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.

uEffect

The effect to use.

uGrain

The grain size.

uDelay

The delay, in milliseconds.

uMaxPass

The maximum number of passes.

bTransparent

Flag that indicates whether to use a transparent color. Possible values are:

Value

Meaning

TRUE

Use the transparent color specified in crTransparent.

FALSE

Do not use a transparent color.

crTransparent

The transparent color to use. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color.

uWandWidth

The width of the wand, in pixels.

crWand

The color of the wand. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color.

uDlgFlags

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

Value

Meaning

DLG_EFFECT_SHOW_CONTEXTHELP

[0x00000001] dialog should contain a context sensitive help icon.

DLG_EFFECT_SHOW_PREVIEW

[0x00000002] show a preview of the image in the dialog. The pBitmap member of this structure should contain a valid bitmap.

DLG_EFFECT_AUTOPREVIEW

[0x00000004] auto preview when options change

DLG_EFFECT_DELAY

[0x00000008] effect delay is an option

DLG_EFFECT_GRAIN

[0x00000010] effect grain is an option

DLG_EFFECT_PASSES

[0x00000020] effect passes is an option

DLG_EFFECT_TRANSPARENT

[0x00000040] transparency is an option

DLG_EFFECT_WAND

[0x00000080] wand is an option

DLG_EFFECT_NO_TREEVIEW

[0x00000100] DO NOT use TreeView

DLG_EFFECT_CLASS_NONE

[0x00000200] no effect is an option

DLG_EFFECT_CLASS_WIPE

[0x00000400] linear wipe is an option

DLG_EFFECT_CLASS_WIPERECT

[0x00000800] rectangular wipe is an option

DLG_EFFECT_CLASS_WIPECIRCLE

[0x00001000] circular wipe is an option

DLG_EFFECT_CLASS_PUSH

[0x00002000] push is an option

DLG_EFFECT_CLASS_SLIDE

[0x00004000] slide is an option

DLG_EFFECT_CLASS_ROLL

[0x00008000] roll is an option

DLG_EFFECT_CLASS_ROTATE

[0x00010000] rotate is an option

DLG_EFFECT_CLASS_ZOOM

[0x00020000] zoom is an option

DLG_EFFECT_CLASS_DRIP

[0x00040000] drip is an option

DLG_EFFECT_CLASS_BLIND

[0x00080000] blind is an option

DLG_EFFECT_CLASS_RANDOM

[0x00100000] random is an option

DLG_EFFECT_CLASS_CHECK

[0x00200000] check is an option

DLG_EFFECT_CLASS_BLOCKS

[0x00400000] blocks is an option

DLG_EFFECT_CLASS_CIRCLE

[0x00800000] circle is an option

DLG_EFFECT_CLASS_ELLIPSE

[0x01000000] ellipse is an option

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 L_FAR *. 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.