IPXV_MainFrame::OpenDocFromPath Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
(11 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_MainFrame::OpenDocFromPath Method}} | {{#customTitle:IPXV_MainFrame::OpenDocFromPath Method}} | ||
+ | {{#parentPage:PXV:IPXV_MainFrame#Methods|OpenDocFromPath|method}} | ||
+ | {{ToReview}} | ||
− | The method | + | The method opens a document from the specified file. |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT OpenDocFromPath([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT OpenDocFromPath([in] BSTR sSrcPath, |
+ | [in, defaultvalue(NULL)] ICab* pOpenParams, | ||
+ | [out, retval, defaultvalue(NULL)] IPXV_Document** pDoc);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;sSrcPath |
− | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the full path to the source file. |
− | ; | + | ;pOpenParams |
− | :[in, | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:ICab|ICab]] specifying the additional parameters for document opening. |
− | ; | + | ;pDoc |
− | :[out, retval, | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the opened document. |
== Return Value == | == Return Value == | ||
Line 19: | Line 24: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXV_MainFrame|IPXV_MainFrame]] |
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.