IPXV_Control::EnableEventListening2 Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 3: Line 3:
 
{{#customTitle:IPXV_Control::EnableEventListening2 Method}}
 
{{#customTitle:IPXV_Control::EnableEventListening2 Method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening2|method}}
 
{{#parentPage:PXV:IPXV_Control#Methods|EnableEventListening2|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Starts/stops listening of specified event.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;nEventID
 
;nEventID
:[in]  Value of LONG.
+
:[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
 
;bEnable
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  The flag to start/stop the listening of event.  
  
 
== Return Value ==
 
== Return Value ==

Revision as of 18:05, 27 May 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.

See Also

IPXV_Control