_ShippingMethodManager::LoadMethodInstance Method [C++]

Article
11/12/2009

Use this method to load an instance of a given shipping method.

Definition

[C++]

HRESULT _ShippingMethodManager::LoadMethodInstance(VARIANT*methodid);

[Visual Basic]

Sub LoadMethodInstance(methodid As Variant)

Parameters

methodid[C++]
[in] A pointer to a VARIANT containing a BSTR that is the method ID of the shipping method.
methodid[Visual Basic]
A String containing the method ID of the shipping method.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

Error Values

[C++] 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.

[Visual Basic] 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 loads an instance of the requested shipping method as a single record in the current recordset.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

[Visual Basic]

Example

' oSMM is an initialized Commerce.ShippingMethodManager object.
' sMethodId is a string containing the method ID.

oSMM.LoadMethodInstance(sMethodId)

Share via