ShippingMethodManager.SetCachableComponentConfig
.gif "Ee797557.c++_on(en-US,CS.10).gif")
.gif "Ee797557.vb_off(en-US,CS.10).gif")
Use this method to set the configuration data for the pipeline component, and other component information.
Definition
Sub SetCachableComponentConfig(progid As Variant,configdict As Variant,action As Variant,actionfriendlyname As Variant)
Parameters
progid
A String containing the ProgID of the pipeline component.
configdict
A Dictionary object holding the configuration information for the component.
action
A String containing the name of the ASP edit page for the shipping component.
actionfriendlyname
A String containing a friendly name for the ASP edit page for the shipping component.
Return Values
None.
Error Values
This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
Remarks
This method acts on the loaded shipping method. You must call LoadMethodInstance or CreateMethodInstance to load a shipping method into the ShippingMethodManager object before calling this method.
This method takes the Configuration dictionary for the component and prepares it to be saved along with the current configuration. In addition, the method stores the ProgID, the edit page, and the page friendly names. The settings are not saved until the SaveMethodConfig method is called.
The configdict parameter is typically obtained using IPipelineComponentAdmin::GetConfigDictionary.
This method utilizes the IPipelineComponentAdmin interface; therefore all shipping components configurable by the ShippingMethodManager object must support the IPipelineComponentAdmin interface.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' oSMM is a Commerce.ShippingMethodManager object
' sProgID, sAction, and sActionFrientlyName are strings
' dConfigDict is a Commerce.Dictionary object
Call oSMM.SetCachableComponentConfig(sProgID, dConfigDict, _
sAction, sActionFriendlyName)