IMSCSAuthManager::URLShopperArgs
.gif "Ee798272.c++_off(en-US,CS.10).gif")
.gif "Ee798272.vb_on(en-US,CS.10).gif")
Use this method to generate a Uniform Resource Locator (URL) encoded query string of name/value pairs and append the ticket to the query string if a ticket is set.
Definition
HRESULT IMSCSAuthManager::URLShopperArgs(VARIANT*pVarURLParameters,VARIANT*pVarURLValues,BSTR*pbstrRet);
Parameters
pVarURLParameters
[in] A pointer to a VARIANT containing a SAFEARRAY of parameter names.
pVarURLValues
[in] A pointer to a VARIANT containing a SAFEARRAY of parameter values corresponding to the parameter names.
pbstrRet
[out, retval] A pointer to a BSTR that contains the resulting URL-encoded query string.
Return Values
This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.
Error Values
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.
The following table shows the custom COM errors that this method can return.
| Constant | Value | Description |
| E_UPM_AUTHMANAGER_API_ASP_ONLY | 0xC1004C24 | This method should only be called within an ASP page. |
| MSG_UPM_AUTH_SITE_NEEDED_ERROR | 0xC1004C10 | 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, 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 concatenates the parameter name/value pairs into a URL-encoded string and appends the ticket. This is useful for cookieless shopping support. This method will fail if the two arrays containing the parameters and values are not the same size.
If both types of tickets exist, the MSCSAuth ticket takes precedence.
Use the URLArgs method to perform URL encoding of parameter/value pairs without appending the ticket.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
The pbstrRet parameter contains valid data only if the method completes successfully.
See Also
IMSCSAuthManager::SetAuthTicket