IMSCSPage_3_0::URLArgs

Ee797538.c++_off(en-US,CS.10).gifEe797538.vb_on(en-US,CS.10).gif

Use this method to generate a series of query string arguments in an appropriate form for passing in a URL. The method applies URL encoding to the values passed in.

Ee797538.important(en-US,CS.10).gif Important

  • This method is included for backwards compatibility with Site Server 3.0 Commerce Edition. See the AuthManager object, which provides similar functionality to that found in the URLArgs method. Using the AuthManager methods  is the preferred way of adding this type of functionality to your site, and will ensure better compatibility with future versions of Microsoft Commerce Server.

Definition

HRESULT IMSCSPage_3_0::URLArgs(BSTR*pbstrRet);

Parameters

pbstrRet

[out, retval] A pointer to a BSTR used to return the series of query string arguments.

Return Values

This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.

Error Values

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.

Remarks

The pbstrRet parameter points to valid data only if the method completed successfully.

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

See Also

Page Object

AuthManager Object

IMSCSPage_3_0::VirtualDirectory

IMSCSPage_3_0::SURL

IMSCSPage_3_0::SURLPrefix

IMSCSPage_3_0::URL

IMSCSPage_3_0::URLShopperArgs


All rights reserved.