IPXV_TextSelection::GetSel Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_TextSelection::GetSel Method}}
 
{{#customTitle:IPXV_TextSelection::GetSel Method}}
{{#parentPage:PXV:IPXV_TextSelection|method}}
+
{{#parentPage:PXV:IPXV_TextSelection#Methods|GetSel|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets page text selection from the given page.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetSel(ULONG nPageIndex, [in, defaultvalue(0)] VARIANT_BOOL bAddIfNotExists, [out, retval] IPXV_PageTextSelection** ppSel);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetSel(                       ULONG                     nPageIndex,
 +
              [in, defaultvalue(0)] VARIANT_BOOL             bAddIfNotExists,
 +
              [out, retval]         IPXV_PageTextSelection** pSel);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nPageIndex''
+
;nPageIndex
: Value of ULONG.
+
: Value of ULONG containing a page index.
;''bAddIfNotExists''
+
;bAddIfNotExists
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL representing whether the selection should be added if it does not exist.
;''ppSel''
+
;pSel
:[out, retval]  Pointer to [[PXV:IPXV_PageTextSelection|IPXV_PageTextSelection]].
+
:[out, retval]  Pointer to [[PXV:IPXV_PageTextSelection|IPXV_PageTextSelection]] containing a resulting page text selection.
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_TextSelection|IPXV_TextSelection]].
+
[[PXV:IPXV_TextSelection|IPXV_TextSelection]]

Latest revision as of 05:09, 27 April 2017


Gets page text selection from the given page.

Syntax

HRESULT GetSel(                       ULONG                     nPageIndex,
               [in, defaultvalue(0)]  VARIANT_BOOL              bAddIfNotExists,
               [out, retval]          IPXV_PageTextSelection**  pSel);

Parameters

nPageIndex
Value of ULONG containing a page index.
bAddIfNotExists
[in, defaultvalue(0)] Value of VARIANT_BOOL representing whether the selection should be added if it does not exist.
pSel
[out, retval] Pointer to IPXV_PageTextSelection containing a resulting page text selection.

Return Value

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

See Also

IPXV_TextSelection