IPXV_Inst::ShowOpenFilesDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::ShowOpenFilesDlg Method}}
 
{{#customTitle:IPXV_Inst::ShowOpenFilesDlg Method}}
{{#parentPage:PXV:IPXV_Inst#Methods|ShowOpenFilesDlg Method|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|ShowOpenFilesDlg|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{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 ==
Line 16: Line 15:
 
                         [in, defaultvalue(0)]  VARIANT_BOOL            bShowHidden,
 
                         [in, defaultvalue(0)]  VARIANT_BOOL            bShowHidden,
 
                         [in, defaultvalue(0)]  LONG                    nFilterIndex,
 
                         [in, defaultvalue(0)]  LONG                    nFilterIndex,
                         [out, retval]          IPXV_OpenFilesDlgRes**  ppRes);</pre>
+
                         [out, retval]          IPXV_OpenFilesDlgRes**  pRes);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pFileFilters
 
;pFileFilters
:[in, defaultvalue("")]  Value of BSTR.
+
:[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("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The initial folder path. If empty string is specified then current folder will be used.
 
;bAllowMult
 
;bAllowMult
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The flag to allow multiple files selection.
 
;pDlgTitle
 
;pDlgTitle
:[in, defaultvalue("")]  Value of BSTR.
+
:[in, defaultvalue("")]  The title of dialog.
 
;hWndParent
 
;hWndParent
:[in, defaultvalue(0)]  Value of HANDLE_T.
+
:[in, defaultvalue(0)]  The optional parameter that specifies the handle of parent window.
 
;bShowHidden
 
;bShowHidden
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Forces the showing of system and hidden files.
 
;nFilterIndex
 
;nFilterIndex
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  The index of filter that should be selected initially.
;ppRes
+
;pRes
:[out, retval]  Pointer to [[PXV:IPXV_OpenFilesDlgRes|IPXV_OpenFilesDlgRes]].
+
:[out, retval]  Returns pointer to [[PXV:IPXV_OpenFilesDlgRes|IPXV_OpenFilesDlgRes]] object.
  
 
== Return Value ==
 
== Return Value ==

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