IPXV_Inst::GetPluginSettings Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IPXV_Inst::GetPluginSettings Method}} | {{#customTitle:IPXV_Inst::GetPluginSettings Method}} | ||
| − | + | Gets reference to node in application's options-storage that contains all settings of specified plugin. | |
== Syntax == | == Syntax == | ||
| Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
;''pPlugin'' | ;''pPlugin'' | ||
| − | : Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]]. | + | : Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. |
;''bCreateIfNotExists'' | ;''bCreateIfNotExists'' | ||
| − | :[in, optional] Value of VARIANT_BOOL. | + | :[in, optional] 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]]. | + | :[out, retval] Pointer to [[PXV:ICabNode|ICabNode]] object pointer. |
== Return Value == | == Return Value == | ||
| Line 19: | Line 19: | ||
== See Also == | == See Also == | ||
| − | See also [[PXV:IPXV_Inst|IPXV_Inst]]. | + | See also [[PXV:IPXV_Inst|IPXV_Inst]], [[PXV:IPXV_Plugin|IPXV_Plugin]], [[PXV:ICabNode|ICabNode]]. |
Revision as of 04:13, 21 March 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, optional] VARIANT_BOOL bCreateIfNotExists, [out, retval] ICabNode** ppPluginSettings);
Parameters
- pPlugin
- Pointer to IPXV_Plugin plug-in object.
- bCreateIfNotExists
- [in, optional] 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.
