IPXC_Bookmark::IsEqual Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Bookmark::IsEqual Method}}
 
{{#customTitle:IPXC_Bookmark::IsEqual Method}}
 +
{{#parentPage:PXV:IPXC_Bookmark#Methods|IsEqual|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Checks whether the given bookmark is equal to the source bookmark. The bookmarks are compared by pointers.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT IsEqual([in] IPXC_Bookmark* pBookmark, [out, retval] VARIANT_BOOL* pEqual);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT IsEqual([in]           IPXC_Bookmark* pBookmark,
 +
                [out, retval] VARIANT_BOOL*   bEqual);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pBookmark''
+
;pBookmark
:[in]  Pointer to [[PXV:IPXC_Bookmark|IPXC_Bookmark]].
+
:[in]  Pointer to [[PXV:IPXC_Bookmark|IPXC_Bookmark]] containing the bookmark to compare.
;''pEqual''
+
;bEqual
:[out, retval]  Pointer to VARIANT_BOOL.
+
:[out, retval]  Returns whether the bookmarks are equal.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Bookmark|IPXC_Bookmark]].
+
[[PXV:IPXC_Bookmark|IPXC_Bookmark]]

Latest revision as of 03:21, 15 June 2015


Checks whether the given bookmark is equal to the source bookmark. The bookmarks are compared by pointers.

Syntax

HRESULT IsEqual([in]           IPXC_Bookmark*  pBookmark,
                [out, retval]  VARIANT_BOOL*   bEqual);

Parameters

pBookmark
[in] Pointer to IPXC_Bookmark containing the bookmark to compare.
bEqual
[out, retval] Returns whether the bookmarks are equal.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXC_Bookmark