Page.URL

Ee785475.c++_on(en-US,CS.10).gifEe785475.vb_off(en-US,CS.10).gif

Use this method to generate a URL based on the specified file name and an optional list of name/value arguments. This URL includes the server name, the virtual directory in which the file is stored, and the name of the file itself.

Additionally, if the StandardSManager for the application is initialized in URL mode, the URL method uses the value stored in the Application object's MSCSSIDUrlKey variable as the name in a name/value pair, the value of which is the current shopper ID.

The method applies URL encoding to the values passed in.

Ee785475.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 URL 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

Function URL(bstrPath As String) As String

Parameters

bstrPath

A String that contains the name of the file to reference in the URL.

Return Values

If this method completes successfully, it returns a String that contains the encoded value.

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

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

Example

' The URL method spares the site builder the need to map a file 
' to the HTTP path to that file. For example, assume the 
following call to URL:
<%= oPage.URL("filename.asp") %>
' This call resolves to the correct HTTP path to 
' filename.asp as follows:
http://host_name/virtual_directory/filename.asp
' The value for host_name is determined by the contents of the 
' site dictionary's InsecureHostName value. The virtual_directory 
' is determined automatically from the scripting context.

See Also

Page Object

AuthManager Object

Page.SURL


All rights reserved.