IPXV_Control::EnableEventListening Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(2 intermediate revisions by the same user not shown) | |||
Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT EnableEventListening([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT EnableEventListening([in] BSTR sEventID, |
[in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | [in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;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> |
Latest revision as of 03: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.