IPXV_Control::EnableEventListening Method
From PDF XChange PDF SDK
(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::EnableEventListening Method}} | {{#customTitle:IPXV_Control::EnableEventListening Method}} | ||
| + | {{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening|method}} | ||
| + | {{ToReview}} | ||
| − | + | Starts/stops listening of specified event. | |
== 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> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;sEventID |
| − | :[in] | + | :[in] The unique name of event. For example: |
| − | ; | + | ::<tt>e.app.prefsChanged</tt> |
| − | :[in, | + | ::<tt>e.activeDocChanged</tt> |
| + | ::<tt>e.stampSelected</tt> | ||
| + | ::<tt>e.pagesView.layoutChanged</tt> | ||
| + | ::<tt>...</tt> | ||
| + | |||
| + | ;bEnable | ||
| + | :[in, defaultvalue(-1)] The flag to start/stop the listening of event. | ||
== Return Value == | == Return Value == | ||
| Line 17: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_Control|IPXV_Control]] | |
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.
