IPXC_Inst::OpenDocumentFromFile Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
(Label ToWrite removed)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Inst::OpenDocumentFromFile Method}}
 
{{#customTitle:IPXC_Inst::OpenDocumentFromFile Method}}
 +
{{#parentPage:PXV:IPXC_Inst#Methods|OpenDocumentFromFile|method}}
 +
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OpenDocumentFromFile([in] BSTR lpszFileName, [in] IPXC_DocAuthCallback* pAuthCallback, [in, optional] ULONG dwFlags, [in, optional] ULONG permsMask, [out, retval] IPXC_Document** ppDocument);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OpenDocumentFromFile([in]                     LPWSTR                lpszFileName,
 +
                            [in]                     IPXC_DocAuthCallback* pAuthCallback,
 +
                            [in, defaultvalue(NULL)] IProgressMon*          pProgressMon,
 +
                            [in, defaultvalue(0)]    ULONG                 nFlags,
 +
                            [in, defaultvalue(0)]     ULONG                 nRestrictPerms,
 +
                            [out, retval]             IPXC_Document**       pDocument);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''lpszFileName''
+
;lpszFileName
:[in]  Value of BSTR.
+
:[in]  Value of LPWSTR containing a path to the document.
;''pAuthCallback''
+
;pAuthCallback
:[in]  Pointer to [[PXV:IPXC_DocAuthCallback|IPXC_DocAuthCallback]].
+
:[in]  Pointer to [[PXV:IPXC_DocAuthCallback|IPXC_DocAuthCallback]] containing the optional callback for password-protected document authentication. If null is passed then password-protected documents will throw an exception.
;''dwFlags''
+
;pProgressMon
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing an optional progress monitor.
;''permsMask''
+
;nFlags
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]].
;''ppDocument''
+
;nRestrictPerms
:[out, retval]  Pointer to [[PXV:IPXC_Document|IPXC_Document]].
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_PermsFlags|Permission flags]].
 +
;pDocument
 +
:[out, retval]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the resulting document.
  
 
== Return Value ==
 
== Return Value ==
Line 23: Line 34:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Inst|IPXC_Inst]].
+
[[PXV:IPXC_Inst|IPXC_Inst]]

Latest revision as of 00:14, 15 October 2018


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT OpenDocumentFromFile([in]                      LPWSTR                 lpszFileName,
                             [in]                      IPXC_DocAuthCallback*  pAuthCallback,
                             [in, defaultvalue(NULL)]  IProgressMon*          pProgressMon,
                             [in, defaultvalue(0)]     ULONG                  nFlags,
                             [in, defaultvalue(0)]     ULONG                  nRestrictPerms,
                             [out, retval]             IPXC_Document**        pDocument);

Parameters

lpszFileName
[in] Value of LPWSTR containing a path to the document.
pAuthCallback
[in] Pointer to IPXC_DocAuthCallback containing the optional callback for password-protected document authentication. If null is passed then password-protected documents will throw an exception.
pProgressMon
[in, defaultvalue(NULL)] Pointer to IProgressMon containing an optional progress monitor.
nFlags
[in, defaultvalue(0)] Value of ULONG containing the PXC_DocumentOpenFlags.
nRestrictPerms
[in, defaultvalue(0)] Value of ULONG containing the Permission flags.
pDocument
[out, retval] Pointer to IPXC_Document containing the resulting document.

Return Value

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

See Also

IPXC_Inst