IBitSet::IsEqual Method

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.

HRESULT IsEqual([in]           IBitSet*       pSource,
                [out, retval]  VARIANT_BOOL*  bVal);

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.

Returns S_OK if the operation was successful, otherwise an error code is returned.

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IBitSet::IsEqual Method}}
-{{#parentPage:PXV:IBitSet|method}}
+{{#parentPage:PXV:IBitSet#Methods|IsEqual|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+'Gets' whether the current bit-set values, when compared, are equal to the source bit-set values.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT IsEqual([in] IBitSet* pSource, [out, retval] VARIANT_BOOL* pVal);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT IsEqual([in]           IBitSet*       pSource,
+                [out, retval]  VARIANT_BOOL*  bVal);</pre>
 == Parameters ==
-;''pSource''
+;pSource
-:[in]  Pointer to [[PXV:IBitSet|IBitSet]].
+:[in]  Pointer to [[PXV:IBitSet|IBitSet]] containing the source bit-set.
-;''pVal''
+;bVal
-:[out, retval]  Pointer to VARIANT_BOOL.
+:[out, retval]  Pointer to VARIANT_BOOL containing the result of the bit-set, to compare.
 == 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]]