ShippingMethodManager.SetCachableComponentConfig Method (PIA)

  • Article

Use this method to set the configuration data for the pipeline component, and other component information.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders
…
Public Sub SetCachableComponentConfig(ByRefprogid As Object,
  ByRefconfigdict As Object,
  ByRefaction As Object,
  ByRefactionfriendlyname As Object)

[C#]

using Microsoft.CommerceServer.Interop.Orders;
…
public void SetCachableComponentConfig(ref objectprogid,
  ref objectconfigdict,
  ref objectaction,
  ref objectactionfriendlyname);

Parameters

[Visual Basic .NET]

  • 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.

[C#]

  • progid
    A reference to an object containing a string that is the ProgID of the pipeline component.
  • configdict
    A reference to an object containing a Dictionary object holding the configuration information for the component.
  • action
    A reference to an object containing a string with the name of the ASP edit page for the shipping component.
  • actionfriendlyname
    A reference to an object containing a string with a friendly name for the ASP edit page for the shipping component.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

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.

[Visual Basic .NET]

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)

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_shipmgr (in cs_shipmgr.dll)

See Also

Splitter

Shipping Class

ShippingDiscountAdjust

ShippingManagerCache

ShippingMethodManager Class

ShippingMethodRouter

StepwiseShipping

Copyright © 2005 Microsoft Corporation.
All rights reserved.