SPWebApplication.GetMappedPage Method (String)

Returns the location of the customized application page.

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

Syntax

'Declaration
Public Function GetMappedPage ( _
    page As String _
) As String
'Usage
Dim instance As SPWebApplication
Dim page As String
Dim returnValue As String

returnValue = instance.GetMappedPage(page)

public string GetMappedPage(
    string page
)

Parameters

• page
  Type: System.String

  The location of the default application page.

Return Value

Type: System.String
The location of the customized application page. Otherwise, a null reference (Nothing in Visual Basic).

Examples

The following code sample shows how to retrieve the custom page mapping based on the default application page location.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Administration;

namespace MapCustomAppPage
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                //Get a reference to the web application.
                SPWebApplication webApp = site.WebApplication;

                //Output the custom application page location.
                Console.Out.WriteLine(webApp.GetMappedPage("/_layouts/accessdenied.aspx"));
               
                Console.Out.WriteLine("Press any key...");
                Console.ReadKey();
            }
        }
    }
}

Imports System
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Administration
Module Module1

    Sub Main()

        Using site As New SPSite("https://localhost")

            'Get a reference to the web application.
            Dim webApp As SPWebApplication = site.WebApplication

            'Output the newly assigned application page.
            Console.Out.WriteLine(webApp.GetMappedPage("/_layouts/accessdenied.aspx"))

            Console.Out.WriteLine("Press any key...")
            Console.ReadKey()
        End Using

    End Sub

End Module

See Also

Reference

SPWebApplication Class

SPWebApplication Members

GetMappedPage Overload

Microsoft.SharePoint.Administration Namespace