IPXC_PageText::GetColor Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXC_PageText::GetColor Method}}
 
{{#customTitle:IPXC_PageText::GetColor Method}}
 
{{#parentPage:PXV:IPXC_PageText#Methods|GetColor|method}}
 
{{#parentPage:PXV:IPXC_PageText#Methods|GetColor|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets color from the page text by the given color index.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nColorIndex
 
;nColorIndex
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the color index.
 
;pColor
 
;pColor
:[out]  Pointer to [[PXV:IColor|IColor]].
+
:[out]  Pointer to [[PXV:IColor|IColor]] containing the resulting color.
 
;nAlpha
 
;nAlpha
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the color's alpha value.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 22:46, 12 May 2016


Gets color from the page text by the given color index.

Syntax

HRESULT GetColor([in]   ULONG     nColorIndex,
                 [out]  IColor**  pColor,
                 [out]  float*    nAlpha);

Parameters

nColorIndex
[in] Value of ULONG containing the color index.
pColor
[out] Pointer to IColor containing the resulting color.
nAlpha
[out] Pointer to float containing the color's alpha value.

Return Value

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

See Also

IPXC_PageText