IPXV_Control::IsEventListening2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (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:IPXV_Control::IsEventListening2 Method}}
 
{{#customTitle:IPXV_Control::IsEventListening2 Method}}
{{#parentPage:PXV:IPXV_Control|method}}
+
{{#parentPage:PXV:IPXV_Control#Methods|IsEventListening2|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Use it to check if control is the listener of specified event.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT IsEventListening2([in] LONG nEventID, [out, retval] VARIANT_BOOL* pEnabled);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT IsEventListening2([in]           LONG           nEventID,
 +
                          [out, retval] VARIANT_BOOL* bEnabled);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nEventID''
+
;nEventID
:[in]  Value of LONG.
+
:[in]  The unique identifier of event.
;''pEnabled''
+
;bEnabled
:[out, retval]  Pointer to VARIANT_BOOL.
+
:[out, retval]  Returns the <tt>true</tt> value when control is listening of the event is and <tt>false</tt> otherwise.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Control|IPXV_Control]].
+
[[PXV:IPXV_Control|IPXV_Control]]

Latest revision as of 03:50, 15 June 2015


Use it to check if control is the listener of specified event.

Syntax

HRESULT IsEventListening2([in]           LONG           nEventID,
                          [out, retval]  VARIANT_BOOL*  bEnabled);

Parameters

nEventID
[in] The unique identifier of event.
bEnabled
[out, retval] Returns the true value when control is listening of the event is and false otherwise.

Return Value

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

See Also

IPXV_Control