IPXV_MainFrame::OpenDocFromPath Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXV_MainFrame::OpenDocFromPath Method}}
 
{{#customTitle:IPXV_MainFrame::OpenDocFromPath Method}}
 
{{#parentPage:PXV:IPXV_MainFrame#Methods|OpenDocFromPath|method}}
 
{{#parentPage:PXV:IPXV_MainFrame#Methods|OpenDocFromPath|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method opens a document from the specified file.  
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;sSrcPath
 
;sSrcPath
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the full path to the source file.
 
;pOpenParams
 
;pOpenParams
:[in, defaultvalue(NULL)]  Pointer to [[PXV:ICab|ICab]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:ICab|ICab]] specifying the additional parameters for document opening.
 
;pDoc
 
;pDoc
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the opened document.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 05:52, 11 April 2016


The method opens a document from the specified file.

Syntax

HRESULT OpenDocFromPath([in]                               BSTR             sSrcPath,
                        [in, defaultvalue(NULL)]           ICab*            pOpenParams,
                        [out, retval, defaultvalue(NULL)]  IPXV_Document**  pDoc);

Parameters

sSrcPath
[in] Value of BSTR containing the full path to the source file.
pOpenParams
[in, defaultvalue(NULL)] Pointer to ICab specifying the additional parameters for document opening.
pDoc
[out, retval, defaultvalue(NULL)] Pointer to IPXV_Document containing the opened document.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXV_MainFrame