IPXV_Inst::ShowSaveFileDlg Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
Line 3: | Line 3: | ||
{{#customTitle:IPXV_Inst::ShowSaveFileDlg Method}} | {{#customTitle:IPXV_Inst::ShowSaveFileDlg Method}} | ||
{{#parentPage:PXV:IPXV_Inst#Methods|ShowSaveFileDlg|method}} | {{#parentPage:PXV:IPXV_Inst#Methods|ShowSaveFileDlg|method}} | ||
− | |||
{{ToReview}} | {{ToReview}} | ||
− | + | Creates an Save File dialog box that lets the user specify the name of a file to save. | |
== Syntax == | == Syntax == | ||
Line 22: | Line 21: | ||
== Parameters == | == Parameters == | ||
;pFileFilters | ;pFileFilters | ||
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] Specifies the set of file-filters for open dialog. For example: |
+ | ::<tt>PDF Documents (*.pdf)|*.pdf|All Files (*.*)|*.*</tt> | ||
+ | ::also you may specify some predefined sets: | ||
+ | ::<tt><allSupp></tt> - specifies all supported filters; | ||
+ | ::<tt><allSuppImg></tt> - specifies all supported images filters; | ||
+ | ::<tt><allSuppRasterImg></tt> - specifies all supported rester-images filters; | ||
;pInitialFolderName | ;pInitialFolderName | ||
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used. |
;pInitialFileName | ;pInitialFileName | ||
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The initial file name. |
;pDefaultExt | ;pDefaultExt | ||
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The default extension. |
;pDlgTitle | ;pDlgTitle | ||
− | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] The title of dialog. |
;hWndParent | ;hWndParent | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window. |
;bOverwritePrompt | ;bOverwritePrompt | ||
− | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] The flag that causes to generate a message box if the selected file already exists. The user must confirm whether to overwrite the file. |
;bShowHidden | ;bShowHidden | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Forces the showing of system and hidden files. |
;nFilterIndex | ;nFilterIndex | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] The index of filter that should be selected initially. |
;ppRes | ;ppRes | ||
− | :[out, retval] | + | :[out, retval] Returns pointer to [[PXV:IPXV_SaveFileDlgRes|IPXV_SaveFileDlgRes]] object. |
== Return Value == | == Return Value == |
Revision as of 18:33, 26 May 2015
Creates an Save File dialog box that lets the user specify the name of a file to save.
Syntax
HRESULT ShowSaveFileDlg([in, defaultvalue("")] BSTR pFileFilters, [in, defaultvalue("")] BSTR pInitialFolderName, [in, defaultvalue("")] BSTR pInitialFileName, [in, defaultvalue("")] BSTR pDefaultExt, [in, defaultvalue("")] BSTR pDlgTitle, [in, defaultvalue(0)] HANDLE_T hWndParent, [in, defaultvalue(-1)] VARIANT_BOOL bOverwritePrompt, [in, defaultvalue(0)] VARIANT_BOOL bShowHidden, [in, defaultvalue(0)] LONG nFilterIndex, [out, retval] IPXV_SaveFileDlgRes** ppRes);
Parameters
- pFileFilters
- [in, defaultvalue("")] Specifies the set of file-filters for open dialog. For example:
- PDF Documents (*.pdf)|*.pdf|All Files (*.*)|*.*
- also you may specify some predefined sets:
- <allSupp> - specifies all supported filters;
- <allSuppImg> - specifies all supported images filters;
- <allSuppRasterImg> - specifies all supported rester-images filters;
- pInitialFolderName
- [in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used.
- pInitialFileName
- [in, defaultvalue("")] The initial file name.
- pDefaultExt
- [in, defaultvalue("")] The default extension.
- pDlgTitle
- [in, defaultvalue("")] The title of dialog.
- hWndParent
- [in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
- bOverwritePrompt
- [in, defaultvalue(-1)] The flag that causes to generate a message box if the selected file already exists. The user must confirm whether to overwrite the file.
- bShowHidden
- [in, defaultvalue(0)] Forces the showing of system and hidden files.
- nFilterIndex
- [in, defaultvalue(0)] The index of filter that should be selected initially.
- ppRes
- [out, retval] Returns pointer to IPXV_SaveFileDlgRes object.
Return Value
Returns S_OK if operation was successful or error code in other cases.