IBitSet::SetWithGrow Method

Latest revision as of 02:12, 15 June 2015

Auxiliary Layer > Interfaces > IBitSet > IBitSet::SetWithGrow Method

Sets a given bit-set item with a given value. If the item's index exceeds the bit-set size, it will be expanded to accommodate that item.

New added items will be filled with a false value.

HRESULT SetWithGrow([in]                    ULONG         nIndex,
                    [in, defaultvalue(-1)]  VARIANT_BOOL  bOn);

Returns S_OK if the operation was successful, otherwise an error code is returned.

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IBitSet::SetWithGrow Method}}
+{{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}}
-The method of interface of PDF-XChange Editor SDK.
+Sets a given bit-set item with a given value. If the item's index exceeds the bit-set [[PXV:IBitSet_Count|size]], it will be expanded to accommodate that item.
+New added items will be filled with a ''false'' value.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT SetWithGrow([in] ULONG nIndex, [in, optional] VARIANT_BOOL bOn);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT SetWithGrow([in]                    ULONG         nIndex,
+                    [in, defaultvalue(-1)]  VARIANT_BOOL  bOn);</pre>
 == Parameters ==
-;''nIndex''
+;nIndex
-:[in]  Value of ULONG.
+:[in]  Index of the item that needs to be set with a value.
-;''bOn''
+;bOn
-:[in, optional]  Value of VARIANT_BOOL.
+:[in, defaultvalue(-1)]  New value of the given item.
 == Return Value ==
-Returns S_OK if operation was successful or error code in other cases.
+Returns <tt>S_OK</tt> if the operation was successful, otherwise an error code is returned.
 == See Also ==
-See also [[PXV:IBitSet|IBitSet]].
+[[PXV:IBitSet|IBitSet]]