IMSCSAuthManager2::URLArgs Method [C++]

Article
11/12/2009

Use this method to generate a URL-encoded query string of name/value pairs.

Definition

[C++]

HRESULT IMSCSAuthManager::URLArgs(VARIANT*pVarURLParameters,
  VARIANT*pVarURLValues,
  BSTR*pbstrRet);

[Visual Basic]

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

Parameters

pVarURLParameters[C++]
[in] A pointer to a VARIANT containing a SAFEARRAY of parameter names.
pVarURLParameters[Visual Basic]
[in] A SafeArray that contains the parameter names.
pVarURLValues[C++]
[in] A pointer to a VARIANT containing a SAFEARRAY of parameter values corresponding to the parameter names.
pVarURLValues[Visual Basic]
[in] A SafeArray that contains the values corresponding to the parameter names.
pbstrRet[C++]
[out, retval] A pointer to a BSTR that contains the resulting URL-encoded query string.

Return Values

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

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

Error Values

[C++] This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

[Visual Basic] 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	[C++] 0xC1004C24 [Visual Basic] &HC1004C24	This method should only be called within an ASP page.
MSG_UPM_AUTH_SITE_NEEDED_ERROR	[C++] 0xC1004C10 [Visual Basic] &HC1004C10	The Initialize method must be called with the installed site name before calling this method.

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

[C++]

The pbstrRet parameter contains valid data only if the method completes successfully.