IPXV_PagesView::SnapPoint Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_PagesView::SnapPoint Method}}
 
{{#customTitle:IPXV_PagesView::SnapPoint Method}}
 +
{{#parentPage:PXV:IPXV_PagesView#Methods|SnapPoint|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT SnapPoint([in] ULONG nPageIdx, [in] PXC_Point* ptIn, [out] PXC_Point* ptOut, [in, optional] ULONG nAddFlags, [in, optional] ULONG nRemoveFlags, [in, optional] PXV_SnapParams* pSnapParams, [in, optional] PXV_GridParams* pGridParams, [out, retval, optional] ULONG* pResFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT SnapPoint([in]                               ULONG           nPageIdx,
 +
                  [in]                               PXC_Point*       ptIn,
 +
                  [out]                             PXC_Point*       ptOut,
 +
                  [in, defaultvalue(0)]             ULONG           nAddFlags,
 +
                  [in, defaultvalue(0)]             ULONG           nRemoveFlags,
 +
                  [in, defaultvalue(NULL)]           PXV_SnapParams* pSnapParams,
 +
                  [in, defaultvalue(NULL)]           PXV_GridParams* pGridParams,
 +
                  [out, retval, defaultvalue(NULL)] ULONG*           pResFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nPageIdx''
+
;nPageIdx
 
:[in]  Value of ULONG.
 
:[in]  Value of ULONG.
−
;''ptIn''
+
;ptIn
 
:[in]  Pointer to [[PXV:PXC_Point|PXC_Point]].
 
:[in]  Pointer to [[PXV:PXC_Point|PXC_Point]].
−
;''ptOut''
+
;ptOut
 
:[out]  Pointer to [[PXV:PXC_Point|PXC_Point]].
 
:[out]  Pointer to [[PXV:PXC_Point|PXC_Point]].
−
;''nAddFlags''
+
;nAddFlags
−
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
−
;''nRemoveFlags''
+
;nRemoveFlags
−
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
−
;''pSnapParams''
+
;pSnapParams
−
:[in, optional]  Pointer to [[PXV:PXV_SnapParams|PXV_SnapParams]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXV_SnapParams|PXV_SnapParams]].
−
;''pGridParams''
+
;pGridParams
−
:[in, optional]  Pointer to [[PXV:PXV_GridParams|PXV_GridParams]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXV_GridParams|PXV_GridParams]].
−
;''pResFlags''
+
;pResFlags
−
:[out, retval, optional]  Pointer to ULONG.
+
:[out, retval, defaultvalue(NULL)]  Pointer to ULONG.
  
 
== Return Value ==
 
== Return Value ==
Line 29: Line 40:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IPXV_PagesView|IPXV_PagesView]].
+
[[PXV:IPXV_PagesView|IPXV_PagesView]]

Latest revision as of 07:33, 12 June 2015

PDF Editor Layer > Interfaces > IPXV_PagesView > IPXV_PagesView::SnapPoint Method


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT SnapPoint([in]                               ULONG            nPageIdx,
                  [in]                               PXC_Point*       ptIn,
                  [out]                              PXC_Point*       ptOut,
                  [in, defaultvalue(0)]              ULONG            nAddFlags,
                  [in, defaultvalue(0)]              ULONG            nRemoveFlags,
                  [in, defaultvalue(NULL)]           PXV_SnapParams*  pSnapParams,
                  [in, defaultvalue(NULL)]           PXV_GridParams*  pGridParams,
                  [out, retval, defaultvalue(NULL)]  ULONG*           pResFlags);

Parameters

nPageIdx
[in] Value of ULONG.
ptIn
[in] Pointer to PXC_Point.
ptOut
[out] Pointer to PXC_Point.
nAddFlags
[in, defaultvalue(0)] Value of ULONG.
nRemoveFlags
[in, defaultvalue(0)] Value of ULONG.
pSnapParams
[in, defaultvalue(NULL)] Pointer to PXV_SnapParams.
pGridParams
[in, defaultvalue(NULL)] Pointer to PXV_GridParams.
pResFlags
[out, retval, defaultvalue(NULL)] Pointer to ULONG.

Return Value

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

See Also

IPXV_PagesView

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXV_PagesView_SnapPoint&oldid=44240"