LEADTOOLS Common Dialog C DLL Help > Quick Reference > Data Types > OPENDLGPARAMS |
typedef struct _OPENDLGPARAMS
{
L_UINT uStructSize ;
LPOPENDLGFILEDATA pFileData ;
L_INT nNumOfFiles ;
L_BOOL bPreviewEnabled;
L_BOOL bShowLoadOptions ;
LTCOMMDLGFILEPREVIEWDATACB pfnFilePreviewData;
L_VOID * pFilePreviewCallBackUserData ;
L_VOID * pImageFileInfoCallBackUserData ;
OPENDLGFILELOADCALLBACK pfnFileLoadCallback ;
L_VOID * pFileLoadCallbackUserData ;
L_UINT32 uDlgFlags ;
LTCOMMDLGHELPCB pfnHelpCallback;
L_VOID * pHelpCallBackUserData ;
INITIALVIEWENUM InitialView;
} OPENDLGPARAMS, * LPOPENDLGPARAMS ;
The OPENDLGPARAMS structure provides information used to initialize the dialog box created by the L_DlgOpen function. After the user closes the dialog box, this structure is updated with information about the user's selections.
Member |
Description |
|
uStructSize |
Size of this structure, in bytes. Use the sizeof operator to calculate this value. |
|
pFileData |
Pointer an array of OPENDLGFILEDATA structures, where each item contains a single image file name and its related loading data. You should free this pointer using the GlobalFree function after freeing the allocated data within the structure. Therefore, for all selected files, you must free any allocated data within each structure of the array and then free this pointer. |
|
nNumOfFiles |
Number of image file(s) selected in the Open dialog. |
|
bPreviewEnabled |
Value that indicates whether to show the Preview window, if DLG_OPEN_SHOW_PREVIEW is set in uDlgFlags. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
View the preview window. |
|
FALSE |
Hide the preview window. |
bShowLoadOptions |
Flag that indicates whether to show the load options when pressing the Open button on the dialog. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Show the load options when pressing the Open button, and check the Show Load Options check box. This will occur whether or not DLG_OPEN_SHOW_LOADOPTIONS is set in uDlgFlags. |
|
FALSE |
Don-t show the load options when pressing the Open button, and uncheck the Show Load Options check box. |
pfnFileLoadCallback |
Pointer to an optional file load callback function. If you do not wish to provide status updates to this dialog, use NULL as the value of this parameter. To provide status updates to this dialog, use the function pointer as the value of this parameter. The callback function must adhere to the prototype described in OPENDLGFILELOADCALLBACK. |
|
pFileLoadCallbackUserData |
Void pointer that you can use to pass one or more additional parameters that the File Load 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 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. |
|
uDlgFlags |
User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are: |
|
|
Value |
|
|
DLG_OPEN_SHOW_CONTEXTHELP |
|
|
DLG_OPEN_SHOW_PROGRESSIVE |
|
|
DLG_OPEN_SHOW_MULTIPAGE |
|
|
DLG_OPEN_SHOW_LOADROTATED |
|
|
DLG_OPEN_SHOW_LOADCOMPRESSED |
|
|
DLG_OPEN_SHOW_FILEINFO |
|
|
DLG_OPEN_SHOW_PREVIEW |
|
|
DLG_OPEN_SHOW_DELPAGE |
|
|
DLG_OPEN_SHOW_LOADOPTIONS |
|
|
DLG_OPEN_VIEWTOTALPAGES |
|
|
DLG_OPEN_ENABLESIZING |
|
|
DLG_OPEN_NOFILEMUSTEXIST |
|
|
DLG_OPEN_NOPATHMUSTEXIST |
|
|
DLG_OPEN_USEFILESTAMP |
|
|
DLG_OPEN_LOADBITMAP |
|
|
DLG_OPEN_GENERATETHUMBNAIL |
|
|
DLG_OPEN_ALWAYSLOADCOMPRESSED |
|
|
DLG_OPEN_ALWAYSLOADROTATED |
|
|
DLG_OPEN_LOADANY |
|
|
DLG_OPEN_SHOW_XPSOPTIONS |
|
|
DLG_OPEN_SHOW_XLSOPTIONS |
|
|
DLG_OPEN_SHOW_RASTERIZEDOCUMENTOPTIONS |
|
|
DLG_OPEN_FILEINFO_MODELESS |
|
|
DLG_OPEN_SHOW_VFFOPTIONS |
|
|
DLG_OPEN_SHOW_ANZOPTIONS |
|
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. |
|
InitialView |
Specifies how OpenFileDialog displays the items in the ListView control. For a list of possible values, refer to INITIALVIEWENUM. |