_ShippingMethodManager::SetCachableComponentConfig
.gif "Ee823787.c++_off(en-US,CS.10).gif")
.gif "Ee823787.vb_on(en-US,CS.10).gif")
Use this method to set the configuration data for the pipeline component, and other component information.
Definition
HRESULT __ShippingMethodManager::SetCachableComponentConfig(VARIANT*progid,VARIANT*configdict,VARIANT*action,VARIANT*actionfriendlyname);
Parameters
progid
[in] A pointer to a VARIANT containing a BSTR that is the ProgID of the pipeline component.
configdict
[in] A VARIANT containing a Dictionary object holding the configuration information for the component.
action
[in] A VARIANT containing a BSTR with the name of the ASP edit page for the shipping component.
actionfriendlyname
[in] A VARIANT containing a BSTR with a friendly name for the ASP edit page for the shipping component.
Return Values
This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.
Error Values
This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT 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, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return 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.