IPXV_Inst::GetTool Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Inst::GetTool Method}}
 
{{#customTitle:IPXV_Inst::GetTool Method}}
 +
{{#parentPage:PXV:IPXV_Inst#Methods|GetTool|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the [[PXV:IPXV_Tool|IPXV_Tool]] object by specified of type-identifier.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetTool([in] LONG nTooID, [out, retval] IPXV_Tool** ppTool);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetTool([in]           LONG         nTooID,
 +
                [out, retval] IPXV_Tool** pTool);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nTooID''
+
;nTooID
:[in]  Value of LONG.
+
:[in]  The unique identifier of tool.
;''ppTool''
+
;pTool
:[out, retval]  Pointer to [[PXV:IPXV_Tool|IPXV_Tool]].
+
:[out, retval]  Returns pointer to [[PXV:IPXV_Tool|IPXV_Tool]] object.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Inst|IPXV_Inst]].
+
[[PXV:IPXV_Inst|IPXV_Inst]]

Latest revision as of 05:55, 18 July 2016


Gets the IPXV_Tool object by specified of type-identifier.

Syntax

HRESULT GetTool([in]           LONG         nTooID,
                [out, retval]  IPXV_Tool**  pTool);

Parameters

nTooID
[in] The unique identifier of tool.
pTool
[out, retval] Returns pointer to IPXV_Tool object.

Return Value

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

See Also

IPXV_Inst