IPXV_Control::EnableEventListening Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_Control::EnableEventListening Method}} | {{#customTitle:IPXV_Control::EnableEventListening Method}} | ||
{{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening|method}} | {{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Starts/stops listening of specified event. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;pEventID | ;pEventID | ||
| − | :[in] | + | :[in] The unique name of event. For example: |
| + | ::<tt>e.app.prefsChanged</tt> | ||
| + | ::<tt>e.activeDocChanged</tt> | ||
| + | ::<tt>e.stampSelected</tt> | ||
| + | ::<tt>e.pagesView.layoutChanged</tt> | ||
| + | ::<tt>...</tt> | ||
| + | |||
;bEnable | ;bEnable | ||
| − | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] The flag to start/stop the listening of event. |
== Return Value == | == Return Value == | ||
Revision as of 19:02, 27 May 2015
Starts/stops listening of specified event.
Syntax
HRESULT EnableEventListening([in] BSTR pEventID,
[in, defaultvalue(-1)] VARIANT_BOOL bEnable);
Parameters
- pEventID
- [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.
