IPXC_Inst::OpenDocumentFrom Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
(Label ToWrite removed)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Inst::OpenDocumentFrom Method}}
 
{{#customTitle:IPXC_Inst::OpenDocumentFrom Method}}
{{#parentPage:PXV:IPXC_Inst|OpenDocumentFrom Method|method}}
+
{{#parentPage:PXV:IPXC_Inst#Methods|OpenDocumentFrom|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Opens the [[PXV:IPXC_Document|IPXC_Document]] from different sources.
  
 
== Syntax ==
 
== Syntax ==
Line 11: Line 12:
 
                         [in]                      IPXC_DocAuthCallback*  pAuthCallback,
 
                         [in]                      IPXC_DocAuthCallback*  pAuthCallback,
 
                         [in, defaultvalue(NULL)]  IProgressMon*          pProgressMon,
 
                         [in, defaultvalue(NULL)]  IProgressMon*          pProgressMon,
                         [in, defaultvalue(0)]    ULONG                  dwFlags,
+
                         [in, defaultvalue(0)]    ULONG                  nFlags,
                         [in, defaultvalue(0)]    ULONG                  permsMask,
+
                         [in, defaultvalue(0)]    ULONG                  nRestrictPerms,
                         [out, retval]            IPXC_Document**        ppDocument);</pre>
+
                         [out, retval]            IPXC_Document**        pDocument);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pSrc
 
;pSrc
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to IUnknown* containing the IString, IStream, [[PXV:IAFS_File|IAFS_File]] or [[PXV:IAFS_Name|IAFS_Name]] with the source 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.
 
;pProgressMon
 
;pProgressMon
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing an optional progress monitor.
;dwFlags
+
;nFlags
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]].
;permsMask
+
;nRestrictPerms
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_PermsFlags|Permission flags]].
;ppDocument
+
;pDocument
:[out, retval]  Pointer to [[PXV:IPXC_Document|IPXC_Document]].
+
:[out, retval]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the resulting document.
  
 
== Return Value ==
 
== Return Value ==
Line 33: Line 34:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Inst|IPXC_Inst]].
+
[[PXV:IPXC_Inst|IPXC_Inst]]

Latest revision as of 01:14, 15 October 2018


Opens the IPXC_Document from different sources.

Syntax

HRESULT OpenDocumentFrom([in]                      IUnknown*              pSrc,
                         [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

pSrc
[in] Pointer to IUnknown* containing the IString, IStream, IAFS_File or IAFS_Name with the source 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