IBitSet::IsEqual Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 3: Line 3:
 
{{#customTitle:IBitSet::IsEqual Method}}
 
{{#customTitle:IBitSet::IsEqual Method}}
 
{{#parentPage:PXV:IBitSet#Methods|IsEqual|method}}
 
{{#parentPage:PXV:IBitSet#Methods|IsEqual|method}}
{{ToReview}}
+
{{}}
  
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 ==
Line 15: Line 15:
 
:[in]  Pointer to [[PXV:IBitSet|IBitSet]] containing the source bit set.
 
:[in]  Pointer to [[PXV:IBitSet|IBitSet]] containing the source bit set.
 
;pVal
 
;pVal
:[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 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:11, 26 May 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*  pVal);

Parameters

pSource
[in] Pointer to IBitSet containing the source bit set.
pVal
[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.

See Also

IBitSet