IPXC_Inst::OpenDocumentFrom Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 18: Line 18:
 
== Parameters ==
 
== Parameters ==
 
;pSrc
 
;pSrc
:[in]  Pointer to IUnknown* containing the IString, IStream, [[PXV:IAFS_File|IAFS_File]] or [[IAFS_Name|IAFS_Name]] with the source document.
+
:[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]] containing the optional callback for password-protected document authentication. If null is passed then password-protected documents will throw an exception.
 
:[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]] containing the optional progress monitor.
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing an optional progress monitor.
 
;nFlags
 
;nFlags
 
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]].
 
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]].

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