IIXC_Page::FillChannel Method

Latest revision as of 02:16, 15 June 2015

Images Core Layer > Interfaces > IIXC_Page > IIXC_Page::FillChannel Method

FillChannel fills a specified rectangle of the page with a specified color value into one specified color channel.

HRESULT FillChannel([in]  IXC_Channel  nDstChannel,
                    [in]  UCHAR        nValue,
                    [in]  RECT*        stRect);

nDstChannel: [in] Specifies color channel which will be used.
nValue: [in] Specifies the value which will be filled with. Possible value is from 0 to 255.
stRect: [in] Pointer to RECT structure which defines the area to be filled.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IIXC_Page::FillChannel Method}}
-{{#parentPage:PXV:IIXC_Page|method}}
+{{#parentPage:PXV:IIXC_Page#Methods|FillChannel|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+'''FillChannel''' fills a specified rectangle of the page with a specified color value into one specified color channel.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT FillChannel([in] IXC_Channel dstChannel, [in] UCHAR nValue, [in] RECT* pRect);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT FillChannel([in]  IXC_Channel  nDstChannel,
+                    [in]  UCHAR        nValue,
+                    [in]  RECT*        stRect);</pre>
 == Parameters ==
-;''dstChannel''
+;nDstChannel
-:[in]  Value of [[PXV:IXC_Channel|IXC_Channel]].
+:[in]  Specifies color [[PXV:IXC_Channel|channel]] which will be used.
-;''nValue''
+;nValue
-:[in]  Value of UCHAR.
+:[in]  Specifies the value which will be filled with. Possible value is from 0 to 255.
-;''pRect''
+;stRect
-:[in]  Pointer to RECT.
+:[in]  Pointer to RECT structure which defines the area to be filled.
 == Return Value ==
@@ Line 22: / Line 23: @@
 == See Also ==
-See also [[PXV:IIXC_Page|IIXC_Page]].
+[[PXV:IIXC_Page|IIXC_Page]]