IMSCSPage_3_0::SURL
.gif "Ee810406.c++_off(en-US,CS.10).gif")
.gif "Ee810406.vb_on(en-US,CS.10).gif")
Use this method to generate a properly formatted secure HTTP URL (SURL) based on the provided file name and an optional list of name/value arguments. The formatted URL includes the server name, the virtual directory in which the file is stored (taken from the context in which the Web site is running), and the name of the file itself.
Additionally, if the StandardSManager for the application is initialized in URL mode, the SURL method uses the value stored in the MSCSSIDUrlKeyApplication object variable as the name in a name/value pair, the value of which is the current customer's shopper ID.
.gif "Ee810406.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 SURL 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::SURL(BSTRbstrPath,BSTR*pbstrRet);
Parameters
bstrPath
[in] A BSTR that contains the name of the file for the SURL to reference.
pbstrRet
[out, retval] A pointer to a BSTR used to return the properly formatted secure HTTP URL.
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.
During application development, you can set the Site.DisableHTTPS property to one (1), which causes the SURL method to use the InsecureHostName value as the host name. The SURL method generates a secure URL only if Site.DisableHTTPS is set to zero (0).
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.