IColor::GetRGB Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IColor::GetRGB Method}}
 
{{#customTitle:IColor::GetRGB Method}}
 
{{#parentPage:PXV:IColor#Methods|GetRGB|method}}
 
{{#parentPage:PXV:IColor#Methods|GetRGB|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets the RGB value of the current color.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nR
 
;nR
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the Red value of the color. Can vary between '''0''' and '''1'''.
 
;nG
 
;nG
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the Green value of the color. Can vary between '''0''' and '''1'''.
 
;nB
 
;nB
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the Blue value of the color. Can vary between '''0''' and '''1'''.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 02:20, 16 March 2017


Gets the RGB value of the current color.

Syntax

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

Parameters

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.

Return Value

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

See Also

IColor