IBitSet::SetWithGrow Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IBitSet::SetWithGrow Method}} | {{#customTitle:IBitSet::SetWithGrow Method}} | ||
{{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}} | {{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}} | ||
| − | |||
| − | Sets given bit set item with given value | + | 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 == | == Syntax == | ||
| Line 13: | Line 14: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] Index of the item that needs to be set with value. | + | :[in] Index of the item that needs to be set with a value. |
;bOn | ;bOn | ||
:[in, defaultvalue(-1)] New value of the given item. | :[in, defaultvalue(-1)] New value of the given item. | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful | + | 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]] | ||
Latest revision as of 03:12, 15 June 2015
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.
Syntax
HRESULT SetWithGrow([in] ULONG nIndex,
[in, defaultvalue(-1)] VARIANT_BOOL bOn);
Parameters
- nIndex
- [in] Index of the item that needs to be set with a value.
- bOn
- [in, defaultvalue(-1)] New value of the given item.
Return Value
Returns S_OK if the operation was successful, otherwise an error code is returned.
