IPXC_Inst::OpenDocumentFromFile Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 18: Line 18:
 
== Parameters ==
 
== Parameters ==
 
;lpszFileName
 
;lpszFileName
:[in]  Value of LPWSTR.
+
:[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.
 
;pProgressMon
 
;pProgressMon
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing an optional progress monitor.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]].
 
;nRestrictPerms
 
;nRestrictPerms
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_PermsFlags|Permission flags]].
 
;pDocument
 
;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 ==

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