IEventsRegistry::RegisterNewEvent Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IEventsRegistry::RegisterNewEvent Method}}
 
{{#customTitle:IEventsRegistry::RegisterNewEvent Method}}
 +
{{#parentPage:PXV:IEventsRegistry#Methods|RegisterNewEvent|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT RegisterNewEvent([in] BSTR pUniqueEventName, [in] IEventCreator* pEventCreator, [in, optional, defaultvalue(NULL)] IBitSet* pEventClass, [out, retval] LONG* pEventID);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT RegisterNewEvent([in]                     BSTR           sUniqueEventName,
 +
                        [in]                     IEventCreator* pEventCreator,
 +
                        [in, defaultvalue(NULL)] IBitSet*       pEventClass,
 +
                        [out, retval]             LONG*           nEventID);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pUniqueEventName''
+
;sUniqueEventName
 
:[in]  Value of BSTR.
 
:[in]  Value of BSTR.
;''pEventCreator''
+
;pEventCreator
 
:[in]  Pointer to [[PXV:IEventCreator|IEventCreator]].
 
:[in]  Pointer to [[PXV:IEventCreator|IEventCreator]].
;''pEventClass''
+
;pEventClass
:[in, optional, defaultvalue(NULL)]  Pointer to [[PXV:IBitSet|IBitSet]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IBitSet|IBitSet]].
;''pEventID''
+
;nEventID
 
:[out, retval]  Pointer to LONG.
 
:[out, retval]  Pointer to LONG.
  
Line 21: Line 28:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IEventsRegistry|IEventsRegistry]].
+
[[PXV:IEventsRegistry|IEventsRegistry]]

Latest revision as of 03:15, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT RegisterNewEvent([in]                      BSTR            sUniqueEventName,
                         [in]                      IEventCreator*  pEventCreator,
                         [in, defaultvalue(NULL)]  IBitSet*        pEventClass,
                         [out, retval]             LONG*           nEventID);

Parameters

sUniqueEventName
[in] Value of BSTR.
pEventCreator
[in] Pointer to IEventCreator.
pEventClass
[in, defaultvalue(NULL)] Pointer to IBitSet.
nEventID
[out, retval] Pointer to LONG.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IEventsRegistry