IPXV_Inst::ShowOpenFilesDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ShowOpenFilesDlg Method}}
 
{{#customTitle:IPXV_Inst::ShowOpenFilesDlg Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|ShowOpenFilesDlg|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Shows an ''Open Files'' 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 ShowOpenFilesDlg([in, optional] BSTR pFileFilters, [in, optional] BSTR pInitialFolderName, [in, optional] VARIANT_BOOL bAllowMult, [in, optional] BSTR pDlgTitle, [in, optional] HANDLE_T hWndParent, [in, optional] VARIANT_BOOL bShowHidden, [in, optional] LONG nFilterIndex, [out, optional] LONG* pFilterIndexOut, [out, retval] IAFS_NamesCollection** ppFileNamesOut);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ShowOpenFilesDlg([in, defaultvalue("")] BSTR                   pFileFilters,
 +
                        [in, defaultvalue("")] BSTR                   pInitialFolderName,
 +
                        [in, defaultvalue(0)]   VARIANT_BOOL           bAllowMult,
 +
                        [in, defaultvalue("")] BSTR                   pDlgTitle,
 +
                        [in, defaultvalue(0)]   HANDLE_T               hWndParent,
 +
                        [in, defaultvalue(0)]   VARIANT_BOOL           bShowHidden,
 +
                        [in, defaultvalue(0)]   LONG                   nFilterIndex,
 +
                        [out, retval]           IPXV_OpenFilesDlgRes** pRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pFileFilters''
+
;pFileFilters
:[in, optionalValue of BSTR.
+
:[in, defaultvalue("")Specifies the set of file-filters for open dialog. For example:
;''pInitialFolderName''
+
::<tt>PDF Documents (*.pdf)|*.pdf|All Files (*.*)|*.*</tt>
:[in, optionalValue of BSTR.
+
::also you may specify some predefined sets:
;''bAllowMult''
+
::<tt><allSupp></tt> - specifies all supported filters;
:[in, optionalValue of VARIANT_BOOL.
+
::<tt><allSuppImg></tt> - specifies all supported images filters;
;''pDlgTitle''
+
::<tt><allSuppRasterImg></tt> - specifies all supported rester-images filters;
:[in, optionalValue of BSTR.
+
;pInitialFolderName
;''hWndParent''
+
:[in, defaultvalue("")The initial folder path. If empty string is specified then current folder will be used.
:[in, optionalValue of HANDLE_T.
+
;bAllowMult
;''bShowHidden''
+
:[in, defaultvalue(0)The flag to allow multiple files selection.
:[in, optionalValue of VARIANT_BOOL.
+
;pDlgTitle
;''nFilterIndex''
+
:[in, defaultvalue("")The title of dialog.
:[in, optionalValue of LONG.
+
;hWndParent
;''pFilterIndexOut''
+
:[in, defaultvalue(0)The optional parameter that specifies the handle of parent window.
:[out, optional]  Pointer to LONG.
+
;bShowHidden
;''ppFileNamesOut''
+
:[in, defaultvalue(0)Forces the showing of system and hidden files.
:[out, retval]  Pointer to [[PXV:IAFS_NamesCollection|IAFS_NamesCollection]].
+
;nFilterIndex
 +
:[in, defaultvalue(0)The index of filter that should be selected initially.
 +
;pRes
 +
:[out, retval]  Returns pointer to [[PXV:IPXV_OpenFilesDlgRes|IPXV_OpenFilesDlgRes]] object.
  
 
== Return Value ==
 
== Return Value ==
Line 31: Line 44:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 03:57, 15 June 2015


Shows an Open Files dialog box that lets the user specify the name of a file(s) to be opened.

Syntax

HRESULT ShowOpenFilesDlg([in, defaultvalue("")]  BSTR                    pFileFilters,
                         [in, defaultvalue("")]  BSTR                    pInitialFolderName,
                         [in, defaultvalue(0)]   VARIANT_BOOL            bAllowMult,
                         [in, defaultvalue("")]  BSTR                    pDlgTitle,
                         [in, defaultvalue(0)]   HANDLE_T                hWndParent,
                         [in, defaultvalue(0)]   VARIANT_BOOL            bShowHidden,
                         [in, defaultvalue(0)]   LONG                    nFilterIndex,
                         [out, retval]           IPXV_OpenFilesDlgRes**  pRes);

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.
bAllowMult
[in, defaultvalue(0)] The flag to allow multiple files selection.
pDlgTitle
[in, defaultvalue("")] The title of dialog.
hWndParent
[in, defaultvalue(0)] The optional parameter that specifies the handle of parent window.
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.
pRes
[out, retval] Returns pointer to IPXV_OpenFilesDlgRes object.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_Inst