IPXC_Inst::OpenDocumentFromFile Method

From Tracker Software PDF SDK
Revision as of 01:14, 15 October 2018 by Palamar (Talk | contribs) (Label ToWrite removed)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


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