IPXV_Inst::FindDocBySrcFile Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::FindDocBySrcFile Method}}
 
{{#customTitle:IPXV_Inst::FindDocBySrcFile Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|FindDocBySrcFile|method}}
 +
{{ToReview}}
  
Finds opened document by pointer to source file object.
+
Finds opened document by source file object.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FindDocBySrcFile([in] IAFS_File* pSrcFile, [out, retval] IPXV_Document** ppDoc);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FindDocBySrcFile([in]           IAFS_File*       pSrcFile,
 +
                        [out, retval] IPXV_Document** pDoc);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pSrcFile''
+
;pSrcFile
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]] object.
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]] object.
;''ppDoc''
+
;pDoc
:[out, retval]  Pointer to the corresponding [[PXV:IPXV_Document|IPXV_Document]] object pointer.
+
:[out, retval]  Returns pointer to the corresponding [[PXV:IPXV_Document|IPXV_Document]] object, if found.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IAFS_File|IAFS_File]], [[PXV:IPXV_Document|IPXV_Document]].
+
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_FindDocByCoreDoc|IPXV_Inst::FindDocByCoreDoc]], [[PXV:IPXV_Inst_FindDocByID|IPXV_Inst::FindDocByID]], [[PXV:IPXV_Inst_FindDocBySrcFileName|IPXV_Inst::FindDocBySrcFileName]], [[PXV:IPXV_Inst_FindDocBySrcFileName2|IPXV_Inst::FindDocBySrcFileName2]]

Latest revision as of 03:56, 15 June 2015


Finds opened document by source file object.

Syntax

HRESULT FindDocBySrcFile([in]           IAFS_File*       pSrcFile,
                         [out, retval]  IPXV_Document**  pDoc);

Parameters

pSrcFile
[in] Pointer to IAFS_File object.
pDoc
[out, retval] Returns pointer to the corresponding IPXV_Document object, if found.

Return Value

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

See Also

IPXV_Inst, IPXV_Inst::FindDocByCoreDoc, IPXV_Inst::FindDocByID, IPXV_Inst::FindDocBySrcFileName, IPXV_Inst::FindDocBySrcFileName2