IPXV_Inst::GetPluginSettings Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in] IPXV_Plugin* | + | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in] IPXV_Plugin* Plugin, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL CreateIfNotExists, |
| − | [out, retval] ICabNode** | + | [out, retval] ICabNode** PluginSettings);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Plugin |
:[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | :[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | ||
| − | ; | + | ;CreateIfNotExists |
:[in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node. | :[in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node. | ||
| − | ; | + | ;PluginSettings |
:[out, retval] Returns pointer to [[PXV:ICabNode|ICabNode]] object. | :[out, retval] Returns pointer to [[PXV:ICabNode|ICabNode]] object. | ||
Revision as of 07:32, 12 June 2015
Gets reference to node in application's options-storage that contains all settings of specified plugin.
Syntax
HRESULT GetPluginSettings([in] IPXV_Plugin* Plugin,
[in, defaultvalue(0)] VARIANT_BOOL CreateIfNotExists,
[out, retval] ICabNode** PluginSettings);
Parameters
- Plugin
- [in] Pointer to IPXV_Plugin plug-in object.
- CreateIfNotExists
- [in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node.
- PluginSettings
- [out, retval] Returns pointer to ICabNode object.
Return Value
Returns S_OK if operation was successful or error code in other cases.
