IPXV_PagesView::SnapPoint Method

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

Latest revision as of 08:33, 12 June 2015


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