IPXC_PageText::GetColor Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(4 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_PageText::GetColor Method}} | {{#customTitle:IPXC_PageText::GetColor Method}} | ||
− | {{#parentPage:PXV:IPXC_PageText#Methods|GetColor | + | {{#parentPage:PXV:IPXC_PageText#Methods|GetColor|method}} |
− | + | ||
{{ToReview}} | {{ToReview}} | ||
− | + | Gets color from the page text by the given color index. | |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetColor([in] ULONG nColorIndex, | <pre class="brush:cpp;gutter:false">HRESULT GetColor([in] ULONG nColorIndex, | ||
− | [out] IColor** | + | [out] IColor** pColor, |
− | [out] float* | + | [out] float* nAlpha);</pre> |
== Parameters == | == Parameters == | ||
;nColorIndex | ;nColorIndex | ||
− | :[in] Value of ULONG. | + | :[in] Value of ULONG containing the color index. |
− | ; | + | ;pColor |
− | :[out] Pointer to [[PXV:IColor|IColor]]. | + | :[out] Pointer to [[PXV:IColor|IColor]] containing the resulting color. |
− | ; | + | ;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.