IPXV_Control::EnableEventListening2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Control::EnableEventListening2 Method}} | {{#customTitle:IPXV_Control::EnableEventListening2 Method}} | ||
+ | {{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening2|method}} | ||
+ | {{ToReview}} | ||
− | + | Starts/stops listening of specified event. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT EnableEventListening2([in] LONG nEventID, [in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT EnableEventListening2([in] LONG nEventID, |
+ | [in, defaultvalue(-1)] VARIANT_BOOL bEnable);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;nEventID |
− | :[in] | + | :[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 |
− | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] The flag to start/stop the listening of event. |
== Return Value == | == Return Value == | ||
Line 17: | Line 21: | ||
== 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 EnableEventListening2([in] LONG nEventID, [in, defaultvalue(-1)] VARIANT_BOOL bEnable);
Parameters
- nEventID
- [in] The unique identifier of event. Use the IPXV_Inst::Str2ID to get number from known string names of events.
- 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.