IPXV_Inst::FireAppPrefsChanged Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::FireAppPrefsChanged Method}} | {{#customTitle:IPXV_Inst::FireAppPrefsChanged Method}} | ||
| + | {{#parentPage:PXV:IPXV_Inst#Methods|FireAppPrefsChanged|method}} | ||
| + | {{ToReview}} | ||
| − | + | Broadcasts the <code>e.app.prefsChanged</code> event with specified index of change-bit '''or''' modifies the input bit-set by this index. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT FireAppPrefsChanged([in] PXV_AppPrefsChanges nFlagIndex, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT FireAppPrefsChanged([in] PXV_AppPrefsChanges nFlagIndex, |
| + | [in, defaultvalue(NULL)] IBitSet* pCumulChangeFlags);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nFlagIndex |
| − | :[in] | + | :[in] Index of change-bit from [[PXV:PXV_AppPrefsChanges|PXV_AppPrefsChanges]]. |
| − | ; | + | ;pCumulChangeFlags |
| − | :[in, | + | :[in, defaultvalue(NULL)] Pass non-NULL pointer to [[PXV:IBitSet|IBitSet]] when you want to collect many change-bits before sending the event. |
== Return Value == | == Return Value == | ||
| Line 17: | Line 21: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Inst_FireAppPrefsChanged2|IPXV_Inst::FireAppPrefsChanged2]] | |
Latest revision as of 03:56, 15 June 2015
Broadcasts the e.app.prefsChanged event with specified index of change-bit or modifies the input bit-set by this index.
Syntax
HRESULT FireAppPrefsChanged([in] PXV_AppPrefsChanges nFlagIndex,
[in, defaultvalue(NULL)] IBitSet* pCumulChangeFlags);
Parameters
- nFlagIndex
- [in] Index of change-bit from PXV_AppPrefsChanges.
- pCumulChangeFlags
- [in, defaultvalue(NULL)] Pass non-NULL pointer to IBitSet when you want to collect many change-bits before sending the event.
Return Value
Returns S_OK if operation was successful or error code in other cases.
