IMSCSPage_3_0::URLEncode
.gif "Ee783961.c++_off(en-US,CS.10).gif")
.gif "Ee783961.vb_on(en-US,CS.10).gif")
Use this method to apply URL-encoding rules, including escape characters, to a specified string. An encoded URL string may be passed in a URL as a query string argument.
.gif "Ee783961.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 URLEncode 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::URLEncode(VARIANTvtValue,BSTR*pbstrRet);
Parameters
vtValue
[in] A VARIANT that contains the string to be encoded.
pbstrRet
[out, retval] A pointer to a BSTR used to return the URL-encoded string.
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.
Strings that contain certain characters, such as spaces, slashes (/), or percentage symbols (%), cannot be passed as URL query arguments. URL encoding encodes these characters as escaped text so that they can be passed in a URL.
The Page.URLEncode method is equivalent to the Server.URLEncode method, except that the Page.URLEncode method handles NULL values by returning an empty string. (The Server.URLEncode method fails when the String parameter is NULL). This distinction is important because database queries can return NULL.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.