IPXV_Inst::FindDocBySrcFileName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::FindDocBySrcFileName Method}}
 
{{#customTitle:IPXV_Inst::FindDocBySrcFileName Method}}
{{#parentPage:PXV:IPXV_Inst|FindDocBySrcFileName Method|method}}
+
{{#parentPage:PXV:IPXV_Inst#Methods|FindDocBySrcFileName|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
Finds opened document by pointer source file name object.
+
Finds opened document by source file name.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT FindDocBySrcFileName([in]          IAFS_Name*      pSrcFileName,
 
<pre class="brush:cpp;gutter:false">HRESULT FindDocBySrcFileName([in]          IAFS_Name*      pSrcFileName,
                             [out, retval]  IPXV_Document**  ppDoc);</pre>
+
                             [out, retval]  IPXV_Document**  pDoc);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pSrcFileName
 
;pSrcFileName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] object.
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]] 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 22: Line 21:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IAFS_Name|IAFS_Name]], [[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_FindDocBySrcFile|IPXV_Inst::FindDocBySrcFile]], [[PXV:IPXV_Inst_FindDocBySrcFileName2|IPXV_Inst::FindDocBySrcFileName2]]

Latest revision as of 02:56, 15 June 2015


Finds opened document by source file name.

Syntax

HRESULT FindDocBySrcFileName([in]           IAFS_Name*       pSrcFileName,
                             [out, retval]  IPXV_Document**  pDoc);

Parameters

pSrcFileName
[in] Pointer to IAFS_Name 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::FindDocBySrcFile, IPXV_Inst::FindDocBySrcFileName2