IPXV_Control::OpenDocFromPath Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Control::OpenDocFromPath Method}}
 
{{#customTitle:IPXV_Control::OpenDocFromPath Method}}
{{#parentPage:PXV:IPXV_Control|OpenDocFromPath Method|method}}
+
{{#parentPage:PXV:IPXV_Control#Methods|OpenDocFromPath|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method opens an document from the specified file.  
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OpenDocFromPath([in]                      BSTR  pSrcPath,
+
<pre class="brush:cpp;gutter:false">HRESULT OpenDocFromPath([in]                      BSTR  sSrcPath,
 
                         [in, defaultvalue(NULL)]  ICab*  pOpenParams);</pre>
 
                         [in, defaultvalue(NULL)]  ICab*  pOpenParams);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pSrcPath
+
;sSrcPath
:[in]  Value of BSTR.
+
:[in]  The string that contains the full path to the source file.
 
;pOpenParams
 
;pOpenParams
:[in, defaultvalue(NULL)]  Pointer to [[PXV:ICab|ICab]].
+
:[in, defaultvalue(NULL)]  An optional pointer to [[PXV:ICab|ICab]] object that specifies the additional parameters for document opening.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 21:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Control|IPXV_Control]].
+
[[PXV:IPXV_Control|IPXV_Control]], [[PXV:IPXV_Control_OpenDocFrom|IPXV_Control::OpenDocFrom]]

Latest revision as of 03:50, 15 June 2015


The method opens an document from the specified file.

Syntax

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

Parameters

sSrcPath
[in] The string that contains the full path to the source file.
pOpenParams
[in, defaultvalue(NULL)] An optional pointer to ICab object that specifies the additional parameters for document opening.

Return Value

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

See Also

IPXV_Control, IPXV_Control::OpenDocFrom