IPXV_Inst::GetPluginSettings Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings(IPXV_Plugin* pPlugin, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings(IPXV_Plugin* pPlugin, [in, defaultvalue(0)] VARIANT_BOOL bCreateIfNotExists, [out, retval] ICabNode** ppPluginSettings);</pre> |
== Parameters == | == Parameters == | ||
| Line 11: | Line 11: | ||
: Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | : Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | ||
;''bCreateIfNotExists'' | ;''bCreateIfNotExists'' | ||
| − | :[in, | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL. Indicates whether to create a plug-in settings node. Default is ''False''. |
;''ppPluginSettings'' | ;''ppPluginSettings'' | ||
:[out, retval] Pointer to [[PXV:ICabNode|ICabNode]] object pointer. | :[out, retval] Pointer to [[PXV:ICabNode|ICabNode]] object pointer. | ||
Revision as of 01:30, 17 April 2015
Gets reference to node in application's options-storage that contains all settings of specified plugin.
Contents
Syntax
HRESULT GetPluginSettings(IPXV_Plugin* pPlugin, [in, defaultvalue(0)] VARIANT_BOOL bCreateIfNotExists, [out, retval] ICabNode** ppPluginSettings);
Parameters
- pPlugin
- Pointer to IPXV_Plugin plug-in object.
- bCreateIfNotExists
- [in, defaultvalue(0)] Value of VARIANT_BOOL. Indicates whether to create a plug-in settings node. Default is False.
- ppPluginSettings
- [out, retval] Pointer to ICabNode object pointer.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IPXV_Inst, IPXV_Plugin, ICabNode.
