ShippingMethodManager.GetInstalledMethodList
.gif "Ee785263.c++_on(en-US,CS.10).gif")
.gif "Ee785263.vb_off(en-US,CS.10).gif")
Use this method to get a list of the current shipping methods. The GetInstalledMethodList method allows you to filter the list, select the columns to return, and to sort the list into a particular order.
Definition
Function GetInstalledMethodList(Filter As Variant,OrderBy As Variant,columns As Variant) As Variant
Parameters
Filter
A String that becomes the WHERE clause of the query. Pass Null if no filtering is wanted. An example filter is "enabled = 1", this will cause GetInstalledMethodList to only return enabled shipping methods.
OrderBy
A String that becomes the ORDER BY clause of the query. Pass a Null if no ordering is wanted. An example OrderBy arguement is "shipping_method_name", which will cause the results to be sorted by shipping method name.
columns
An Array of column names of the values to retrieve. If an empty array is passed, all columns from the ShippingConfig table are returned.
Return Values
If this method completes successfully, it returns an ADO Recordset object that contains the results of the query.
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
The GetInstalledMethodList method constructs a SQL query from its three parameters, runs it against the current ShippingConfig table, and returns the result in an ADO Recordset object.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Example
' oSMM is an initialized Commerce.ShippingMethodManager object
' sFilter is set to filter
' sOrderBy is set to null, so there will be no ordering
' AColumns is an array of column names of the values to retrieve
' rsMethodList is a recordset
"'""'"Set rsMethodList = oSMM.GetInstalledMethodList( _
"enabled = 1", _
Null, _
Array("shipping_method_name") _
)