IPXC_Inst::OpenDocumentFromFile Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
(Label ToWrite removed) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Inst::OpenDocumentFromFile Method}} | {{#customTitle:IPXC_Inst::OpenDocumentFromFile Method}} | ||
| − | {{#parentPage:PXV:IPXC_Inst#Methods|OpenDocumentFromFile | + | {{#parentPage:PXV:IPXC_Inst#Methods|OpenDocumentFromFile|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| Line 12: | Line 12: | ||
[in] IPXC_DocAuthCallback* pAuthCallback, | [in] IPXC_DocAuthCallback* pAuthCallback, | ||
[in, defaultvalue(NULL)] IProgressMon* pProgressMon, | [in, defaultvalue(NULL)] IProgressMon* pProgressMon, | ||
| − | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG nFlags, |
| − | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG nRestrictPerms, |
| − | [out, retval] IPXC_Document** | + | [out, retval] IPXC_Document** pDocument);</pre> |
== 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 |
| − | :[in, defaultvalue(0)] Value of ULONG. | + | :[in, defaultvalue(0)] Value of ULONG containing the [[PXV:PXC_DocumentOpenFlags|PXC_DocumentOpenFlags]]. |
| − | ; | + | ;nRestrictPerms |
| − | :[in, defaultvalue(0)] Value of ULONG. | + | :[in, defaultvalue(0)] Value of ULONG containing the [[PXV:PXC_PermsFlags|Permission flags]]. |
| − | ; | + | ;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 == | ||
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.
