AuthManager.URLArgs

Ee825190.c++_on(en-US,CS.10).gifEe825190.vb_off(en-US,CS.10).gif

Use this method to generate a Uniform Resource Locator (URL) encoded query string of name/value pairs.

Definition

Function URLArgs(pVarURLParameters As Variant,pVarURLValues As Variant) As String

Parameters

pVarURLParameters

[in] A SafeArray that contains the parameter names.

pVarURLValues

[in] A SafeArray that contains the values corresponding to the parameter names.

Return Values

If this method completes successfully, it returns a String that contains the encoded URL query string.

Error Values

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant Value Description
E_UPM_AUTHMANAGER_API_ASP_ONLY &HC1004C24 This method should only be called within an ASP page.
MSG_UPM_AUTH_SITE_NEEDED_ERROR &HC1004C10 The Initialize method must be called with the installed site name before calling this method.

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 concatenates the parameter name/value pairs into a URL-encoded string. This method will fail if the two arrays containing the parameter names and values are not the same size.

The URLShopperArgs method performs the same URL encoding and additionally appends the ticket to the query string, if a ticket is set.

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

Example

' saParameterNames and saParameterValues are SafeArrays
' sURLArg is a string
' oAuthManager is a Commerce AuthManager object

saParameterNames(0) = "sku1"
saParameterNames(1) = "sku3"
saParameterValues(0) = "12345"
saParameterValues(1) = "98765"
sURLArg = oAuthManager.URLArgs(saParameterNames, saParameterValues)

' sURLArg = "sku1=12345&sku3=98765"

See Also

AuthManager Object

AuthManager.URLShopperArgs


All rights reserved.