IUIX_Inst::CreateColor Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::CreateColor Method}}
 
{{#customTitle:IUIX_Inst::CreateColor Method}}
 +
{{#parentPage:PXV:IUIX_Inst#Methods|CreateColor|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Creates new object of [[PXV:IColor|IColor]] interface (''color'').
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateColor([in, optional] ColorType nColorType, [out, retval] IColor** ppColor);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateColor([in, defaultvalue(ColorType_RGB)] ColorType nColorType,
 +
                    [out, retval]                     IColor**   pColor);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nColorType''
+
;nColorType
:[in, optionalValue of [[PXV:ColorType|ColorType]].
+
:[in, defaultvalue(ColorType_RGB)Color type value from [[PXV:ColorType|ColorType]] enumeration.
;''ppColor''
+
;pColor
:[out, retval]  Pointer to [[PXV:IColor|IColor]].
+
:[out, retval]  return object of [[PXV:IColor|IColor]] interace.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 17:21, 15 June 2015


Creates new object of IColor interface (color).

Syntax

HRESULT CreateColor([in, defaultvalue(ColorType_RGB)]  ColorType  nColorType,
                    [out, retval]                      IColor**   pColor);

Parameters

nColorType
[in, defaultvalue(ColorType_RGB)] Color type value from ColorType enumeration.
pColor
[out, retval] return object of IColor interace.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst