IPXV_Control::EnableEventListening Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT EnableEventListening([in]                    BSTR          EventID,
+
<pre class="brush:cpp;gutter:false">HRESULT EnableEventListening([in]                    BSTR          sEventID,
                             [in, defaultvalue(-1)]  VARIANT_BOOL  Enable);</pre>
+
                             [in, defaultvalue(-1)]  VARIANT_BOOL  bEnable);</pre>
  
 
== Parameters ==
 
== Parameters ==
;EventID
+
;sEventID
 
:[in]  The unique name of event. For example:
 
:[in]  The unique name of event. For example:
 
::<tt>e.app.prefsChanged</tt>
 
::<tt>e.app.prefsChanged</tt>
Line 20: Line 20:
 
::<tt>...</tt>
 
::<tt>...</tt>
  
;Enable
+
;bEnable
 
:[in, defaultvalue(-1)]  The flag to start/stop the listening of event.  
 
:[in, defaultvalue(-1)]  The flag to start/stop the listening of event.  
  

Latest revision as of 02:49, 15 June 2015


Starts/stops listening of specified event.

Syntax

HRESULT EnableEventListening([in]                    BSTR          sEventID,
                             [in, defaultvalue(-1)]  VARIANT_BOOL  bEnable);

Parameters

sEventID
[in] The unique name of event. For example:
e.app.prefsChanged
e.activeDocChanged
e.stampSelected
e.pagesView.layoutChanged
...
bEnable
[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