IColor::GetRGB Method

Latest revision as of 03:20, 16 March 2017

Gets the RGB value of the current color.

HRESULT GetRGB([out]  float*  nR,
               [out]  float*  nG,
               [out]  float*  nB);

nR: [out] Pointer to float containing the Red value of the color. Can vary between 0 and 1.
nG: [out] Pointer to float containing the Green value of the color. Can vary between 0 and 1.
nB: [out] Pointer to float containing the Blue value of the color. Can vary between 0 and 1.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IColor::GetRGB Method}}
-{{#parentPage:PXV:IColor|method}}
+{{#parentPage:PXV:IColor#Methods|GetRGB|method}}
-{{ToWrite}}
 {{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets the RGB value of the current color.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetRGB([out] float* pR, [out] float* pG, [out] float* pb);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT GetRGB([out]  float*  nR,
+               [out]  float*  nG,
+               [out]  float*  nB);</pre>
 == Parameters ==
-;''pR''
+;nR
-:[out]  Pointer to float.
+:[out]  Pointer to float containing the Red value of the color. Can vary between '''0''' and '''1'''.
-;''pG''
+;nG
-:[out]  Pointer to float.
+:[out]  Pointer to float containing the Green value of the color. Can vary between '''0''' and '''1'''.
-;''pb''
+;nB
-:[out]  Pointer to float.
+:[out]  Pointer to float containing the Blue value of the color. Can vary between '''0''' and '''1'''.
 == Return Value ==
@@ Line 22: / Line 24: @@
 == See Also ==
-See also [[PXV:IColor|IColor]].
+[[PXV:IColor|IColor]]