IPXV_Inst::GetPluginSettings Method
From PDF XChange PDF SDK
Line 16: | Line 16: | ||
:[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | :[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object. | ||
;bCreateIfNotExists | ;bCreateIfNotExists | ||
− | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Tha flag indicates whether to create a plug-in settings node. |
;ppPluginSettings | ;ppPluginSettings | ||
− | :[out, retval] | + | :[out, retval] Returns pointer to [[PXV:ICabNode|ICabNode]] object. |
== Return Value == | == Return Value == |
Revision as of 10:03, 25 May 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** ppPluginSettings);
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.
- ppPluginSettings
- [out, retval] Returns pointer to ICabNode object.
Return Value
Returns S_OK if operation was successful or error code in other cases.