IBitSet::SetWithGrow Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(12 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IBitSet::SetWithGrow Method}}
 
{{#customTitle:IBitSet::SetWithGrow Method}}
{{#parentPage:PXV:IBitSet#Methods|SetWithGrow Method|method}}
+
{{#parentPage:PXV:IBitSet#Methods|SetWithGrow|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
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 ==
 
== Syntax ==
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nIndex
 
;nIndex
:[in]  Value of ULONG.
+
:[in]  Index of the item that needs to be set with a value.
 
;bOn
 
;bOn
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[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 <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.

See Also

IBitSet