IPXV_Inst::ShowSelectFolderDlg Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::ShowSelectFolderDlg Method}} | {{#customTitle:IPXV_Inst::ShowSelectFolderDlg Method}} | ||
− | {{#parentPage:PXV:IPXV_Inst|method | + | {{#parentPage:PXV:IPXV_Inst#Methods|ShowSelectFolderDlg|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Shows an ''Select Folder'' dialog box that lets the user specify the name of a file(s) to be opened. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT ShowSelectFolderDlg([in, defaultvalue("")] BSTR pInitialFolderName, [in, defaultvalue("")] BSTR pDlgTitle, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(-1)] VARIANT_BOOL bCanAddNew, [out, retval] IAFS_Name** | + | <pre class="brush:cpp;gutter:false">HRESULT ShowSelectFolderDlg([in, defaultvalue("")] BSTR pInitialFolderName, |
+ | [in, defaultvalue("")] BSTR pDlgTitle, | ||
+ | [in, defaultvalue(0)] HANDLE_T hWndParent, | ||
+ | [in, defaultvalue(-1)] VARIANT_BOOL bCanAddNew, | ||
+ | [out, retval] IAFS_Name** pRes);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pInitialFolderName |
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used. |
− | ; | + | ;pDlgTitle |
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The title of dialog. |
− | ; | + | ;hWndParent |
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window. |
− | ; | + | ;bCanAddNew |
− | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] The flags to include the ''New Folder'' button in the dialog box. |
− | + | ;pRes | |
− | :[out, retval] | + | :[out, retval] Returns pointer to [[PXV:IAFS_Name|IAFS_Name]] object. |
== Return Value == | == Return Value == | ||
Line 26: | Line 30: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_Inst|IPXV_Inst]] |
Latest revision as of 03:57, 15 June 2015
Shows an Select Folder dialog box that lets the user specify the name of a file(s) to be opened.
Syntax
HRESULT ShowSelectFolderDlg([in, defaultvalue("")] BSTR pInitialFolderName, [in, defaultvalue("")] BSTR pDlgTitle, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(-1)] VARIANT_BOOL bCanAddNew, [out, retval] IAFS_Name** pRes);
Parameters
- pInitialFolderName
- [in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used.
- pDlgTitle
- [in, defaultvalue("")] The title of dialog.
- hWndParent
- [in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
- bCanAddNew
- [in, defaultvalue(-1)] The flags to include the New Folder button in the dialog box.
- pRes
- [out, retval] Returns pointer to IAFS_Name object.
Return Value
Returns S_OK if operation was successful or error code in other cases.