IPXV_MainFrame::OpenDocFrom Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_MainFrame::OpenDocFrom Method}}
 
{{#customTitle:IPXV_MainFrame::OpenDocFrom Method}}
{{#parentPage:PXV:IPXV_MainFrame|OpenDocFrom Method|method}}
+
{{#parentPage:PXV:IPXV_MainFrame#Methods|OpenDocFrom|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Opens a document from the specified source.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT OpenDocFrom([in]                              IUnknown*        pSrc,
 
<pre class="brush:cpp;gutter:false">HRESULT OpenDocFrom([in]                              IUnknown*        pSrc,
 
                     [in, defaultvalue(NULL)]          ICab*            pOpenParams,
 
                     [in, defaultvalue(NULL)]          ICab*            pOpenParams,
                     [out, retval, defaultvalue(NULL)]  IPXV_Document**  ppDoc);</pre>
+
                     [out, retval, defaultvalue(NULL)]  IPXV_Document**  pDoc);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pSrc
 
;pSrc
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to IUnknown* containing a pointer to [[PXV:IAFS_Name|IAFS_Name]]/[[PXV:IAFS_File|IAFS_File]]/IStream object that specifies the source of all user's preferences. Also via [[PXV:IString|IString]] you may specify the full path to a 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.
;ppDoc
+
;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 ==
Line 25: Line 24:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_MainFrame|IPXV_MainFrame]].
+
[[PXV:IPXV_MainFrame|IPXV_MainFrame]]

Latest revision as of 06:54, 11 April 2016


Opens a document from the specified source.

Syntax

HRESULT OpenDocFrom([in]                               IUnknown*        pSrc,
                    [in, defaultvalue(NULL)]           ICab*            pOpenParams,
                    [out, retval, defaultvalue(NULL)]  IPXV_Document**  pDoc);

Parameters

pSrc
[in] Pointer to IUnknown* containing a pointer to IAFS_Name/IAFS_File/IStream object that specifies the source of all user's preferences. Also via IString you may specify the full path to a 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