ShippingMethodManager.GetComponentConfig Method (PIA)

Article
11/12/2009

Use this method to retrieve the Configuration dictionary for the shipping component to implement the current shipping method. The shipping method must be loaded using LoadMethodInstance before calling GetComponentConfig.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Orders
…
Public Function GetComponentConfig() As Object

[C#]

using Microsoft.CommerceServer.Interop.Orders;
…
public object GetComponentConfig();

Return Values

[Visual Basic .NET] If this method completes successfully, it returns an Object that contains the Configuration dictionary for the current shipping method.

[C#] An object containing the Configuration dictionary.

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.

[Visual Basic .NET]

Example

' oSMM is an initialized, loaded Commerce.ShippingMethodManager object

dConfig = oSMM.GetComponentConfig()

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: cs_shipmgr (in cs_shipmgr.dll)