IPXV_Inst::GetPluginSettings Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in]                         IPXV_Plugin*  pPlugin,
+
<pre class="brush:cpp;gutter:false">HRESULT GetPluginSettings([in]                   IPXV_Plugin*  pPlugin,
 
                           [in, defaultvalue(0)]  VARIANT_BOOL  bCreateIfNotExists,
 
                           [in, defaultvalue(0)]  VARIANT_BOOL  bCreateIfNotExists,
 
                           [out, retval]          ICabNode**    ppPluginSettings);</pre>
 
                           [out, retval]          ICabNode**    ppPluginSettings);</pre>

Revision as of 10:01, 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)] 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

IPXV_Inst