IBitSet::IsEqual Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IBitSet::IsEqual Method}} | {{#customTitle:IBitSet::IsEqual Method}} | ||
{{#parentPage:PXV:IBitSet#Methods|IsEqual|method}} | {{#parentPage:PXV:IBitSet#Methods|IsEqual|method}} | ||
| − | |||
| − | Gets whether the current bit set values are equal to the source bit set values. | + | 'Gets' whether the current bit-set values, when compared, are equal to the source bit-set values. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT IsEqual([in] IBitSet* pSource, | <pre class="brush:cpp;gutter:false">HRESULT IsEqual([in] IBitSet* pSource, | ||
| − | [out, retval] VARIANT_BOOL* | + | [out, retval] VARIANT_BOOL* bVal);</pre> |
== Parameters == | == Parameters == | ||
;pSource | ;pSource | ||
| − | :[in] Pointer to [[PXV:IBitSet|IBitSet]] containing the source bit set. | + | :[in] Pointer to [[PXV:IBitSet|IBitSet]] containing the source bit-set. |
| − | ; | + | ;bVal |
| − | :[out, retval] Pointer to VARIANT_BOOL containing the result of the bit set compare. | + | :[out, retval] Pointer to VARIANT_BOOL containing the result of the bit-set, to compare. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful | + | Returns S_OK 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 02:12, 15 June 2015
'Gets' whether the current bit-set values, when compared, are equal to the source bit-set values.
Syntax
HRESULT IsEqual([in] IBitSet* pSource,
[out, retval] VARIANT_BOOL* bVal);
Parameters
- pSource
- [in] Pointer to IBitSet containing the source bit-set.
- bVal
- [out, retval] Pointer to VARIANT_BOOL containing the result of the bit-set, to compare.
Return Value
Returns S_OK if the operation was successful, otherwise an error code is returned.
