IPXV_Inst::ShowSaveFileDlg Method

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.

See Also

IPXV_Inst