SPUtility.DetermineRedirectUrl Method

Helper function that determines a redirection URL, typically for server-side redirects. For example, a redirection that uses SPUtility.Redirect.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedExternalType)> _
Public Shared Function DetermineRedirectUrl ( _
    urlProposed As String, _
    flags As SPRedirectFlags, _
    context As HttpContext, _
    queryString As String, _
    <OutAttribute> ByRef urlRedirect As String _
) As Boolean
'Usage
Dim urlProposed As String
Dim flags As SPRedirectFlags
Dim context As HttpContext
Dim queryString As String
Dim urlRedirect As String
Dim returnValue As Boolean

returnValue = SPUtility.DetermineRedirectUrl(urlProposed, _
    flags, context, queryString, urlRedirect)

[SubsetCallableExcludeMemberAttribute(SubsetCallableExcludeMemberType.UnsupportedExternalType)]
public static bool DetermineRedirectUrl(
    string urlProposed,
    SPRedirectFlags flags,
    HttpContext context,
    string queryString,
    out string urlRedirect
)

Parameters

• urlProposed
  Type: System.String

  The redirection URL.

• flags
  Type: Microsoft.SharePoint.Utilities.SPRedirectFlags

  A bit flag array consisting of one or more values from SPRedirectFlags.

• context
  Type: System.Web.HttpContext

  The HttpContext to use, typically Current.

• queryString
  Type: System.String

  Additional query string to use for the redirection URL. This is appended to the returned URL urlRedirect.

• urlRedirect
  Type: System.String

  When this method returns, contains a String that contains the redirection URL. This parameter is passed uninitialized.

Return Value

Type: System.Boolean
A redirection URL.

See Also

Reference

SPUtility Class

SPUtility Members

Microsoft.SharePoint.Utilities Namespace