IPXV_Control::EnableEventListening2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT EnableEventListening2([in]                    LONG          nEventID,
+
<pre class="brush:cpp;gutter:false">HRESULT EnableEventListening2([in]                    LONG          EventID,
                               [in, defaultvalue(-1)]  VARIANT_BOOL  bEnable);</pre>
+
                               [in, defaultvalue(-1)]  VARIANT_BOOL  Enable);</pre>
  
 
== Parameters ==
 
== Parameters ==
;nEventID
+
;EventID
 
:[in]  The unique identifier of event. Use the [[PXV:IPXV_Inst_Str2ID|IPXV_Inst::Str2ID]] to get number from known string names of events.
 
:[in]  The unique identifier of event. Use the [[PXV:IPXV_Inst_Str2ID|IPXV_Inst::Str2ID]] to get number from known string names of events.
;bEnable
+
;Enable
 
:[in, defaultvalue(-1)]  The flag to start/stop the listening of event.  
 
:[in, defaultvalue(-1)]  The flag to start/stop the listening of event.  
  

Revision as of 07:25, 12 June 2015


Starts/stops listening of specified event.

Syntax

HRESULT EnableEventListening2([in]                    LONG          EventID,
                              [in, defaultvalue(-1)]  VARIANT_BOOL  Enable);

Parameters

EventID
[in] The unique identifier of event. Use the IPXV_Inst::Str2ID to get number from known string names of events.
Enable
[in, defaultvalue(-1)] The flag to start/stop the listening of event.

Return Value

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

See Also

IPXV_Control