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)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_PagesView::SnapPoint Method}}
 
{{#customTitle:IPXV_PagesView::SnapPoint Method}}
{{#parentPage:PXV:IPXV_PagesView|method}}
+
{{#parentPage:PXV:IPXV_PagesView|SnapPoint Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<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(0)] 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(0)] 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, defaultvalue(0)]  Value of ULONG.
 
:[in, defaultvalue(0)]  Value of ULONG.
;''nRemoveFlags''
+
;nRemoveFlags
 
:[in, defaultvalue(0)]  Value of ULONG.
 
:[in, defaultvalue(0)]  Value of ULONG.
;''pSnapParams''
+
;pSnapParams
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXV_SnapParams|PXV_SnapParams]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXV_SnapParams|PXV_SnapParams]].
;''pGridParams''
+
;pGridParams
 
:[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(0)]  Pointer to ULONG.
  

Revision as of 06:30, 23 April 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(0)]  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(0)] Pointer to ULONG.

Return Value

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

See Also

See also IPXV_PagesView.