BuildUrl Method (String, Boolean, String, String)

  • Article

(Obsolete) Use this method to generate an encoded URL string, with a name and value.

Namespace:  Microsoft.CommerceServer.Runtime
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Function BuildUrl ( _
    fileName As String, _
    secure As Boolean, _
    urlParameterName As String, _
    urlParameterValue As String _
) As String

'Usage
Dim instance As QueryStringBuilder
Dim fileName As String
Dim secure As Boolean
Dim urlParameterName As String
Dim urlParameterValue As String
Dim returnValue As String

returnValue = instance.BuildUrl(fileName, _
    secure, urlParameterName, urlParameterValue)

public string BuildUrl(
    string fileName,
    bool secure,
    string urlParameterName,
    string urlParameterValue
)

public:
String^ BuildUrl(
    String^ fileName, 
    bool secure, 
    String^ urlParameterName, 
    String^ urlParameterValue
)

public function BuildUrl(
    fileName : String, 
    secure : boolean, 
    urlParameterName : String, 
    urlParameterValue : String
) : String

Parameters

  • secure
    Type: System..::.Boolean
    The secure flag, set to true for https and false for http. Https will be used for the URL if this flag is true and the site is enabled for https.

Return Value

Type: System..::.String
The encoded URL string.

Exceptions

Exception Condition
ArgumentNullException

urlParameterName is nullNothingnullptra null reference (Nothing in Visual Basic).
CommerceAuthenticationException

The URL could not be obtained.

Remarks

You have to use the BuildUrl method every time you want to append the ticket to the URL in a cookieless scenario. If this is not done, the ticket will not be passed on to the next request. If filename is not nullNothingnullptra null reference (Nothing in Visual Basic), the COM method AuthManager.GetURL is called. If filename is nullNothingnullptra null reference (Nothing in Visual Basic), and if the CookieSupport property is set to true, then the AuthManager.UrlShopperArgs COM method is called. If filename is nullNothingnullptra null reference (Nothing in Visual Basic) and the CookieSupport property is set to false, then AuthManager.UrlArgs COM method is called.

Permissions

See Also

Reference

QueryStringBuilder Class

QueryStringBuilder Members

BuildUrl Overload

Microsoft.CommerceServer.Runtime Namespace