IPXC_PageText::HitTest Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_PageText::HitTest Method}}
 
{{#customTitle:IPXC_PageText::HitTest Method}}
{{#parentPage:PXV:IPXC_PageText|method}}
+
{{#parentPage:PXV:IPXC_PageText|HitTest Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in] PXC_PointF* pPosOnPage, [in] float nHitLineDelta, VARIANT_BOOL bGetNearestIfFail, [out] LONG* pLineIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT HitTest([in]   PXC_PointF*   pPosOnPage,
 +
                [in]   float         nHitLineDelta,
 +
                      VARIANT_BOOL bGetNearestIfFail,
 +
                [out] LONG*         pLineIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pPosOnPage''
+
;pPosOnPage
 
:[in]  Pointer to [[PXV:PXC_PointF|PXC_PointF]].
 
:[in]  Pointer to [[PXV:PXC_PointF|PXC_PointF]].
;''nHitLineDelta''
+
;nHitLineDelta
 
:[in]  Value of float.
 
:[in]  Value of float.
;''bGetNearestIfFail''
+
;bGetNearestIfFail
 
: Value of VARIANT_BOOL.
 
: Value of VARIANT_BOOL.
;''pLineIndex''
+
;pLineIndex
 
:[out]  Pointer to LONG.
 
:[out]  Pointer to LONG.
  

Revision as of 06:10, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT HitTest([in]   PXC_PointF*   pPosOnPage,
                [in]   float         nHitLineDelta,
                       VARIANT_BOOL  bGetNearestIfFail,
                [out]  LONG*         pLineIndex);

Parameters

pPosOnPage
[in] Pointer to PXC_PointF.
nHitLineDelta
[in] Value of float.
bGetNearestIfFail
Value of VARIANT_BOOL.
pLineIndex
[out] Pointer to LONG.

Return Value

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

See Also

See also IPXC_PageText.