IPXC_PageText::HitTest Method
From PDF XChange PDF SDK
Gets line index by the given point on page. Will return -1 when no lines are in the point's area.
Syntax
HRESULT HitTest([in] PXC_PointF* stPosOnPage, [in] float nHitLineDelta, [in] VARIANT_BOOL bGetNearestIfFail, [out] LONG* nLineIndex);
Parameters
- stPosOnPage
- [in] Pointer to PXC_PointF containing the point on page that needs to be checked.
- nHitLineDelta
- [in] Value of float containing the delta value. When specified, it will check the area near the point that exeeds to the given delta value.
- bGetNearestIfFail
- [in] Value of VARIANT_BOOL representing whether the nearest line should be searched for if none are in the point area.
- nLineIndex
- [out] Pointer to LONG containing the resulting line index.
Return Value
Returns S_OK if operation was successful or error code in other cases.