IPXC_PageText::GetColor Method

Latest revision as of 22:46, 12 May 2016

PDF Core Layer > Interfaces > IPXC_PageText > IPXC_PageText::GetColor Method

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

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

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXC_PageText::GetColor Method}}
+{{#parentPage:PXV:IPXC_PageText#Methods|GetColor|method}}
+{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets color from the page text by the given color index.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetColor([in] ULONG nColorIndex, [out] IColor** ppColor, [out] float* pAlpha);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT GetColor([in]   ULONG     nColorIndex,
+                 [out]  IColor**  pColor,
+                 [out]  float*    nAlpha);</pre>
 == Parameters ==
-;''nColorIndex''
+;nColorIndex
-:[in]  Value of ULONG.
+:[in]  Value of ULONG containing the color index.
-;''ppColor''
+;pColor
-:[out]  Pointer to [[PXV:IColor|IColor]].
+:[out]  Pointer to [[PXV:IColor|IColor]] containing the resulting color.
-;''pAlpha''
+;nAlpha
-:[out]  Pointer to float.
+:[out]  Pointer to float containing the color's alpha value.
 == Return Value ==
@@ Line 19: / Line 24: @@
 == See Also ==
-See also [[PXV:IPXC_PageText|IPXC_PageText]].
+[[PXV:IPXC_PageText|IPXC_PageText]]