IBitSet::SetWithGrow Method

From Tracker Software PDF SDK
Jump to: navigation, search
Line 5: Line 5:
  
  
Sets a given bit set item with a given value adding it to the bit set and expanding to accommodate any extended bit set size.  
+
Sets a given bit set item with a given value. If item's index exceeds the bit set [[PXV:IBitSet_Count|size]], it will be expanded to accommodate that item.
  
Note that adding new items will not influence any other items values.
+
New added items will be filled with ''false'' value.
  
 
== Syntax ==
 
== Syntax ==
Line 20: Line 20:
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if the operation was successful otherwise an error code is returned.
+
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]]

Revision as of 15:21, 26 May 2015


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

New added items will be filled with 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.

See Also

IBitSet