IPXV_Inst::GetPluginSettings Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (14 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::GetPluginSettings Method}} | {{#customTitle:IPXV_Inst::GetPluginSettings Method}} | ||
| + | {{#parentPage:PXV:IPXV_Inst#Methods|GetPluginSettings|method}} | ||
| + | {{ToReview}} | ||
| − | + | Gets reference to node in application's options-storage that contains all settings of specified plugin. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings(IPXV_Plugin* pPlugin, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in] IPXV_Plugin* pPlugin, |
| + | [in, defaultvalue(0)] VARIANT_BOOL bCreateIfNotExists, | ||
| + | [out, retval] ICabNode** pPluginSettings);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pPlugin |
| − | : Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]]. | + | :[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. |
| − | ; | + | ;bCreateIfNotExists |
| − | :[in, | + | :[in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node. |
| − | ; | + | ;pPluginSettings |
| − | :[out, retval] | + | :[out, retval] Returns pointer to [[PXV:ICabNode|ICabNode]] object. |
== Return Value == | == Return Value == | ||
| Line 19: | Line 24: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_Inst|IPXV_Inst]] | |
Latest revision as of 03:56, 15 June 2015
Gets reference to node in application's options-storage that contains all settings of specified plugin.
Syntax
HRESULT GetPluginSettings([in] IPXV_Plugin* pPlugin,
[in, defaultvalue(0)] VARIANT_BOOL bCreateIfNotExists,
[out, retval] ICabNode** pPluginSettings);
Parameters
- pPlugin
- [in] Pointer to IPXV_Plugin plug-in object.
- bCreateIfNotExists
- [in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node.
- pPluginSettings
- [out, retval] Returns pointer to ICabNode object.
Return Value
Returns S_OK if operation was successful or error code in other cases.
