IBitSet::SetWithGrow Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#customTitle:IBitSet::SetWithGrow Method}}
 
{{#customTitle:IBitSet::SetWithGrow Method}}
 
{{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}}
 
{{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}}
{{ToReview}}
 
  
Sets given bit set item with given value adding it to the bit set if the index is exceeding the bit set size. Note that adding new items will not influence the other items values.
+
 
 +
Sets a given bit set item with a given value adding it to the bit set if the index is exceeding the bit set size. Note that adding new items will not influence any other items values.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
== 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 or error code in other cases.
+
Returns S_OK if the operation was successful otherwise an error code is returned.
  
 
== See Also ==
 
== See Also ==
 
[[PXV:IBitSet|IBitSet]]
 
[[PXV:IBitSet|IBitSet]]

Revision as of 14:27, 26 May 2015


Sets a given bit set item with a given value adding it to the bit set if the index is exceeding the bit set size. Note that adding new items will not influence any other items values.

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