GETDIRECTORYDLGPARAMS

typedef struct _GETDIRECTORYDLGPARAMS 
{ 
   L_UINT uStructSize; 
   L_TCHAR *pszDirectory; 
   L_INT nBuffSize; 
   L_TCHAR *pszFilter; 
   L_INT nFilterIndex; 
   L_TCHAR *pszTitle; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID * pHelpCallBackUserData; 
} GETDIRECTORYDLGPARAMS,* LPGETDIRECTORYDLGPARAMS; 

The GETDIRECTORYDLGPARAMS structure provides information used to initialize the dialog box created by the L_DlgGetDirectory 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.

pszDirectory

Character string containing the directory name. Set this to initialize the dialog to open a particular directory. This will be filled with the user's directory selection.

nBuffSize

Size of the pszDirectory buffer. This should be at least L_MAXPATH bytes.

pszFilter

Character string containing filter string pairs. The last string must be terminated by two NULL characters. The first string in each pair is the display string and describes the filter (ex. "LEAD"). The second string in each pair is the filter pattern (ex. ".CMP"). Use a ";" between patterns to specify multiple filter patterns (ex. ".CMP;.JPEG;.JPG"). This is the same as would be used in the Microsoft SDK structure OPENFILENAMEW. (If you pass NULL, the file type combo box will disappear in the dialog).

nFilterIndex

An integer variable to be updated with the filter index that the user has selected in the dialog box. The first filter has an index of 1.

pszTitle

Character sting containing the title for the dialog box.

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.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Common Dialog C API Help