IPXC_PageText::GetCharsFlags 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:IPXC_PageText::GetCharsFlags Method}}
 
{{#customTitle:IPXC_PageText::GetCharsFlags Method}}
{{#parentPage:PXV:IPXC_PageText|method}}
+
{{#parentPage:PXV:IPXC_PageText#Methods|GetCharsFlags|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets [[PXV:PXC_TextCharFlags|characters' flags]] from the given page text interval.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetCharsFlags([in] ULONG nFirstCharIndex, [in] ULONG nCharsCount, [out] ULONG* pCharsFlags);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetCharsFlags([in]   ULONG   nFirstCharIndex,
 +
                      [in]   ULONG   nCharsCount,
 +
                      [out] ULONG* nCharsFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFirstCharIndex''
+
;nFirstCharIndex
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the starting character index.
;''nCharsCount''
+
;nCharsCount
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the number of characters.
;''pCharsFlags''
+
;nCharsFlags
:[out]  Pointer to ULONG.
+
:[out]  Pointer to ULONG containing the [[PXV:PXC_TextCharFlags|characters' flags]].
  
 
== Return Value ==
 
== Return Value ==
Line 22: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_PageText|IPXC_PageText]].
+
[[PXV:IPXC_PageText|IPXC_PageText]]

Latest revision as of 22:43, 12 May 2016


Gets characters' flags from the given page text interval.

Syntax

HRESULT GetCharsFlags([in]   ULONG   nFirstCharIndex,
                      [in]   ULONG   nCharsCount,
                      [out]  ULONG*  nCharsFlags);

Parameters

nFirstCharIndex
[in] Value of ULONG containing the starting character index.
nCharsCount
[in] Value of ULONG containing the number of characters.
nCharsFlags
[out] Pointer to ULONG containing the characters' flags.

Return Value

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

See Also

IPXC_PageText