IPXV_Inst::FindDocByID Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::FindDocByID Method}}
 
{{#customTitle:IPXV_Inst::FindDocByID Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|FindDocByID|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Finds opened document by unique identifier.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FindDocByID([in] ULONG nDocID, [out, retval] IPXV_Document** pDoc);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FindDocByID([in]           ULONG           nDocID,
 +
                    [out, retval] IPXV_Document** pDoc);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nDocID''
+
;nDocID
:[in]  Value of ULONG.
+
:[in]  The unique document ID to search for.
;''pDoc''
+
;pDoc
:[out, retval]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[out, retval]  Returns pointer to [[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:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_FindDocByCoreDoc|IPXV_Inst::FindDocByCoreDoc]], [[PXV:IPXV_Inst_FindDocBySrcFile|IPXV_Inst::FindDocBySrcFile]], [[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 unique identifier.

Syntax

HRESULT FindDocByID([in]           ULONG            nDocID,
                    [out, retval]  IPXV_Document**  pDoc);

Parameters

nDocID
[in] The unique document ID to search for.
pDoc
[out, retval] Returns pointer to 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::FindDocBySrcFile, IPXV_Inst::FindDocBySrcFileName, IPXV_Inst::FindDocBySrcFileName2