IPXV_Inst::FindDocBySrcFile Method

Latest revision as of 02:56, 15 June 2015

PDF Editor Layer > Interfaces > IPXV_Inst > IPXV_Inst::FindDocBySrcFile Method

Finds opened document by source file object.

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

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

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#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 ==
-<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 ==
-;''pSrcFile''
+;pSrcFile
 :[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 ==
@@ Line 17: / Line 21: @@
 == 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]]