IColor::GetValue Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Parent page removed)
 
(6 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IColor::GetValue Method}}
 
{{#customTitle:IColor::GetValue Method}}
{{ToWrite}}
+
{{#parentPage:PXV:IColor#Methods|GetValue|method}}
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets each of the four possible values of the color. Should be used with the [[PXV:IColor_Type|Type]] property.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetValue([out]  float*  pV0,
+
<pre class="brush:cpp;gutter:false">HRESULT GetValue([out]  float*  nV0,
                 [out]  float*  pV1,
+
                 [out]  float*  nV1,
                 [out]  float*  pV2,
+
                 [out]  float*  nV2,
                 [out]  float*  pV3);</pre>
+
                 [out]  float*  nV3);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pV0
+
;nV0
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the 0 indexed color value.
;pV1
+
;nV1
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the 1 indexed color value.
;pV2
+
;nV2
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the 2 indexed color value.
;pV3
+
;nV3
:[out]  Pointer to float.
+
:[out]  Pointer to float containing the 3 indexed color value.
  
 
== Return Value ==
 
== Return Value ==
Line 27: Line 27:
  
 
== See Also ==
 
== See Also ==
[[PXV:IColor|IColor]].
+
[[PXV:IColor|IColor]]

Latest revision as of 03:25, 16 March 2017


Gets each of the four possible values of the color. Should be used with the Type property.

Syntax

HRESULT GetValue([out]  float*  nV0,
                 [out]  float*  nV1,
                 [out]  float*  nV2,
                 [out]  float*  nV3);

Parameters

nV0
[out] Pointer to float containing the 0 indexed color value.
nV1
[out] Pointer to float containing the 1 indexed color value.
nV2
[out] Pointer to float containing the 2 indexed color value.
nV3
[out] Pointer to float containing the 3 indexed color value.

Return Value

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

See Also

IColor