IPXV_Control::OpenDocWithDlg Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Control::OpenDocWithDlg Method}}
 
{{#customTitle:IPXV_Control::OpenDocWithDlg Method}}
 +
{{#parentPage:PXV:IPXV_Control#Methods|OpenDocWithDlg|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 to be opened.  
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OpenDocWithDlg([in, defaultvalue("")] BSTR pInitialPath, [in, defaultvalue(0)] VARIANT_BOOL bOnlyPDF, [in, defaultvalue(0)] VARIANT_BOOL bNoErrorUI);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OpenDocWithDlg([in, defaultvalue("")] BSTR         sInitialPath,
 +
                      [in, defaultvalue(0)]   VARIANT_BOOL bOnlyPDF,
 +
                      [in, defaultvalue(0)]   VARIANT_BOOL bNoErrorUI);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pInitialPath''
+
;sInitialPath
:[in, defaultvalue("")] Value of BSTR.
+
:[in, defaultvalue("")]   The initial folder path. If empty string is specified then current folder will be used.
;''bOnlyPDF''
+
;bOnlyPDF
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The flag that restricts the user's choice to PDF files only.
;''bNoErrorUI''
+
;bNoErrorUI
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  The flag that prevents the showing of open-error message.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Control|IPXV_Control]].
+
[[PXV:IPXV_Control|IPXV_Control]]

Latest revision as of 03:50, 15 June 2015


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

Syntax

HRESULT OpenDocWithDlg([in, defaultvalue("")]  BSTR          sInitialPath,
                       [in, defaultvalue(0)]   VARIANT_BOOL  bOnlyPDF,
                       [in, defaultvalue(0)]   VARIANT_BOOL  bNoErrorUI);

Parameters

sInitialPath
[in, defaultvalue("")] The initial folder path. If empty string is specified then current folder will be used.
bOnlyPDF
[in, defaultvalue(0)] The flag that restricts the user's choice to PDF files only.
bNoErrorUI
[in, defaultvalue(0)] The flag that prevents the showing of open-error message.

Return Value

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

See Also

IPXV_Control