IPXV_Inst::GetPluginSettings Method

From PDF XChange PDF SDK
Jump to: navigation, search
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*  Plugin,
+
<pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in]                  IPXV_Plugin*  pPlugin,
                           [in, defaultvalue(0)]  VARIANT_BOOL  CreateIfNotExists,
+
                           [in, defaultvalue(0)]  VARIANT_BOOL  bCreateIfNotExists,
                           [out, retval]          ICabNode**    PluginSettings);</pre>
+
                           [out, retval]          ICabNode**    pPluginSettings);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Plugin
+
;pPlugin
 
:[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object.
 
:[in] Pointer to [[PXV:IPXV_Plugin|IPXV_Plugin]] plug-in object.
;CreateIfNotExists
+
;bCreateIfNotExists
 
:[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
+
;pPluginSettings
 
:[out, retval]  Returns pointer to [[PXV:ICabNode|ICabNode]] object.
 
:[out, retval]  Returns pointer to [[PXV:ICabNode|ICabNode]] object.
  

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.

See Also

IPXV_Inst