IPXV_Control::IsEventListening Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXV_Control::IsEventListening Method}}
 
{{#customTitle:IPXV_Control::IsEventListening Method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|IsEventListening|method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|IsEventListening|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 IsEventListening([in]          BSTR          pEventID,
+
<pre class="brush:cpp;gutter:false">HRESULT IsEventListening([in]          BSTR          sEventID,
                         [out, retval]  VARIANT_BOOL*  pEnabled);</pre>
+
                         [out, retval]  VARIANT_BOOL*  bEnabled);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pEventID
+
;sEventID
:[in]  Value of BSTR.
+
:[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 22: Line 21:
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXV_Control|IPXV_Control]]
+
[[PXV:IPXV_Control|IPXV_Control]], [[PXV:IPXV_Control_IsEventListening2|IPXV_Control::IsEventListening2]]

Latest revision as of 03:50, 15 June 2015


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

Syntax

HRESULT IsEventListening([in]           BSTR           sEventID,
                         [out, retval]  VARIANT_BOOL*  bEnabled);

Parameters

sEventID
[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, IPXV_Control::IsEventListening2